Workbooks API Reference

NOTE: This general API reference document does not include information about Custom Fields, Reports or other customisations for a specific database. To access specific detailed API Reference documentation for your database, please go to Start ▶ Configuration ▶ Automation ▶ API Reference.

Accounting Periods — accounting/accounting_periods.api

Activities — activity/activities.api

Activity Attendees — activity/activity_attendees.api

Activity Queues — activity/activity_queues.api

Api Datas — automation/api_data.api

Attachments — resource_upload_files.api

Campaign Membership Statuses — crm/campaign_membership_status.api

Campaign Memberships — crm/campaign_membership.api

Case Queues — crm/case_queues.api

Cases — crm/cases.api

Custom Fields — admin/custom_fields.api

Customer Contract Line Items — accounting/contract_line_items.api

Customer Contract Queues — accounting/contract_queues.api

Customer Contracts — accounting/contracts.api

Customer Credit Note Line Items — accounting/credit_note_line_items.api

Customer Credit Note Queues — accounting/credit_note_queues.api

Customer Credit Notes — accounting/credit_notes.api

Customer Invoice Line Items — accounting/invoice_line_items.api

Customer Invoice Queues — accounting/invoice_queues.api

Customer Invoices — accounting/invoices.api

Customer Order Line Items — accounting/sales_order_line_items.api

Customer Order Queues — accounting/sales_order_queues.api

Customer Orders — accounting/sales_orders.api

Customer Quotation Line Items — accounting/quotation_line_items.api

Customer Quotation Queues — accounting/quotation_queues.api

Customer Quotations — accounting/quotations.api

Dashboard Entries — dashboard_entry.api

Dashboards — dashboard.api

Document Contacts — accounting/document_header_contacts.api

Document Relationships — accounting/document_header_relationships.api

Emails — email/emails.api

External Links — external_link_notes.api

Files — upload_files.api

Google Doc Notes — google_doc_notes.api

Integration Processes — automation/integration_actions.api

Integration States — integration_state.api

Library Assets — asset_library/assets.api

Marketing Campaign Queues — crm/marketing_campaign_queues.api

Marketing Campaigns — crm/campaigns.api

Meetings — activity/meetings.api

Notes — abstract_notes.api

Notes — notes.api

Notifications — notifications/notifications.api

On Change Process Listeners — automation/scheduled_action_listeners.api

On Change Processes — automation/on_change_actions.api

Opportunities — crm/opportunities.api

Opportunity Line Items — crm/opportunity_line_items.api

Opportunity Queues — crm/opportunity_queues.api

Opportunity Stages — admin/opportunity_stages.api

Organisation Queues — crm/organisation_queues.api

Organisations — crm/organisations.api

Party Relationship Types — admin/party_relationship_types.api

Party Relationships — crm/party_relationships.api

People — crm/people.api

Person Queues — crm/person_queues.api

Picklist Entries — admin/picklist_entries.api

Picklists — admin/picklists.api

Pricing Schemes — pricebook/pricing_schemes.api

Process Parameters — automation/action_parameters.api

Products — pricebook/products.api
Related Items — activity/activity_links.api
Related Items — related_items.api

Report Views — reporting/data_views.api

Reports — reporting/reports.api

Sales Lead People — crm/person_lead_parties.api

Sales Lead Person Queues — crm/person_lead_party_queues.api

Sales Lead Queues — crm/sales_lead_queues.api

Sales Leads — crm/sales_leads.api

Sales Tax Codes — accounting/sales_tax_codes.api

Sales Tax Values — accounting/sales_tax_values.api

Scheduled Processes — automation/scheduled_actions.api

Script Dependencies — automation/script_dependencies.api

Script Parameters — automation/script_parameters.api

Scripts — automation/scripts.api

Searchables — searchables.api

Supplier Order Line Items — accounting/purchase_order_line_items.api

Supplier Order Queues — accounting/purchase_order_queues.api

Supplier Orders — accounting/purchase_orders.api

Supply Schemes — pricebook/supply_schemes.api

Tasks — activity/tasks.api

Tax Regimes — accounting/tax_regimes.api

Users — admin/users.api

Web Processes — automation/web_actions.api

Accounting Period

Class Private::Accounting::AccountingPeriod

A time period within a financial year

API URLs

API requests for this model should be directed to accounting/accounting_periods.api

The full metadata for this model can be obtained by an API client using the URL accounting/accounting_periods/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_year[name]	Year	Year name							visible	nil	string (255)
accounting_year_id	Accounting year	Foreign key for accounting_year							invisible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
from_date	Period start date	Period start date							visible	nil	date
full_name	Full period name	Full period name							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Short period name	Short period name							visible	nil	string (255)
sub_period	Quarter	Quarter							visible	nil	string (255)
thru_date	Period end date	Period end date							visible	nil	date
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
accounting_year	Accounting year	Accounting Year	Private::Accounting::AccountingYear	belongs_to	accounting_year_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Activity

Class Private::Activity::Activity

Planned or historic tasks

See the help on Activities for more details.

API URLs

API requests for this model should be directed to activity/activities.api

The full metadata for this model can be obtained by an API client using the URL activity/activities/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Priority (activity_priority)
Status (activity_status)
Type (activity_type)
Assigned to (assigned_to)
Subject (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
activity_priority	Priority	The priority of the activity.							visible	"Medium"	string (255)	Picklist: Activity Priorities Picklist id: 21 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
activity_status	Status	The status of the activity.							visible	"New"	string (255)	Picklist: Activity Statuses Picklist id: 17 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
activity_type	Type	The type of the activity. NOTE: "Meeting" is not a valid value for a Task.							visible	"To-do"	string (255)	Picklist: Activity Types Picklist id: 12 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Activity Queues (Private::Activity::ActivityQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Activity_Activity/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
completed_date	Completed Date	The date that the activity was completed.							visible	nil	date
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The details of the activity.							visible	""	text (16777215)
descriptor	Subject and type	Combined Subject and Type of the activity.							visible	nil	string (255)
due_datetime	Start	The date and time that the activity will start. The time element should be ignored for Task records.							visible	nil	datetime
end_datetime	End	The date and time that the activity will finish.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location	Location	The location of the meeting.							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Subject	Subject of the activity.							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
primary_contact[employer_name]	Primary contact employer name	The name of the employer for the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][alternate_email]	Primary contact alternate email address	The alternate email address of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][alternate_telephone]	Primary contact alternate phone number	The alternate telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][email]	Primary contact email address	The email address of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][mobile]	Primary contact mobile number	The mobile number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][telephone]	Primary contact phone number	The telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[name]	Primary contact	The name of the primary contact of the activity.							visible	nil	string (255)
primary_contact_id	Primary contact ID	The ID of the primary contact Person or Sales lead.							invisible	nil	integer (4)	Linked item: primary_contact_item_linked_item Title: Primary contact Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty) Association: primary_contact Value field: id Display field: name Path: /picklist_data/Private_Activity_Activity/id/name.wbjson?_linked_item_name=primary_contact_id Return fields: [ employer_name, website, type, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
primary_contact_type	Primary contact type	Foreign type for primary_contact							invisible	nil	string (255)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Activity is assigned to.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
queue_entry[queue_id]	Assigned to id	The id of the queue that this Activity is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Activity was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.	Private::Activity::ActivityQueue	has_one	assigned_to		1	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
primary_contact	Primary contact	The primary contact of the activity.	Private::Crm::Person Private::Crm::PersonLeadParty	belongs_to	primary_contact_id		0	1
queue	Assigned to	The Queue that this Activity is assigned to.	Private::Activity::ActivityQueue	has_one	activity_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Activity to the Queue.	Private::Activity::ActivityQueueEntry	has_one	activity_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Activity Attendee

Class Private::Activity::ActivityAttendee

Attendees for an Activity

See the help on Activity Attendees for more details.

API URLs

API requests for this model should be directed to activity/activity_attendees.api

The full metadata for this model can be obtained by an API client using the URL activity/activity_attendees/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
activity_id	Activity	Foreign key for activity							invisible	nil	integer (4)
additional_guests	Additional Guests	The number of additional guests that this Attendee will be bringing.							visible	0	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	Describes the Attendee using a combination of their email address, potential display name, and the name of the associated Activity.							visible	nil	string (255)
email_address	Email Address	The email address for this Attendee.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_optional	Is Optional	Flag indicating that this Attendee is optional.							visible	false	boolean (1)
is_organiser	Is Organiser	Flag indicating that this Attendee is the Organiser of the associated meeting.							visible	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
is_primary_contact	Is Primary Contact	Flag indicating that this Attendee is the primary contact for the associated meeting.							visible	false	boolean (1)
is_required	Is Required	Flag indicating that this Attendee is required.							visible	true	boolean (1)
is_resource	Is Resource	Flag indicating that this Attendee is a resource (i.e. Meeting Room, Projector etc).							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
person_name	Person Name	The person name for this Attendee.							visible	nil	string (255)
related_party_id	Related party	Foreign key for related_party							invisible	nil	integer (4)
related_party_type	Related party type	Foreign type for related_party							invisible	nil	string (255)
response_comments	Response Comments	Any comments made by the Attendee when responding to whether they will be attending.							visible	nil	string (255)
response_status	Response Status	Details whether the Attendee as responded and whether they are attending.							visible	"inviteNotSent"	string (255)	Picklist: Value field: id Display field: name Data: [ {name => 'Invitation not sent', id => 'inviteNotSent'}, {name => 'Awaiting response', id => 'needsAction'}, {name => 'Yes', id => 'accepted'}, {name => 'Maybe', id => 'tentative'}, {name => 'No', id => 'declined'} ]
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
activity	Activity	The associated Activity for this Attendee.	Private::Activity::Activity	belongs_to	activity_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
related_party	Related Contact	The Person or Lead related to the Attendee.	Private::Crm::Person Private::Crm::PersonLeadParty	belongs_to	related_party_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Activity Queue

Class Private::Activity::ActivityQueue

A list of Activities assigned to a waiting list

API URLs

API requests for this model should be directed to activity/activity_queues.api

The full metadata for this model can be obtained by an API client using the URL activity/activity_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
activities	Activities	The set of Activities on this queue.	Private::Activity::Activity	has_many	activity_queue_id	queue_entries	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Activity::ActivityQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Api Data

Class Private::Automation::ApiData

A persistent key-value store for Workbooks API clients

See the help on Api Datas for more details.

API URLs

API requests for this model should be directed to automation/api_data.api

The full metadata for this model can be obtained by an API client using the URL automation/api_data/metadata.api

Mandatory Fields

This model has mandatory fields:

Key (key)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
key	Key	A key to identify this API Data item							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
value	Value	The value which is stored for this API Data item							visible	nil	text (16777215)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Attachment

Class Private::ResourceUploadFile

A file uploaded into Workbooks and associated with a record

See the help on Attachments for more details.

API URLs

API requests for this model should be directed to resource_upload_files.api

The full metadata for this model can be obtained by an API client using the URL resource_upload_files/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
descriptor	Descriptor	The resource upload files descriptor							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
resource_attribute	Resource attribute	The attribute in the resource that the file is attached to.							visible	nil	string (255)
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
upload_file[created_at]	Date uploaded	When the file was uploaded to Workbooks.							visible	nil	datetime
upload_file[created_by_user][person_name]	Uploaded by	Who the file was uploaded by.							visible	nil	string (255)
upload_file[data]	File	The file.							visible	nil	binary
upload_file[file_content_type]	Content type	The Content-Type (MIME type) of the file.							visible	nil	string (255)
upload_file[file_extension]	Extension	The file extension from the filename.							visible	nil	string (255)
upload_file[file_hash]	File MD5 Digest	The MD5 hash of the content of the file.							visible	nil	string (255)
upload_file[file_name]	Filename	The file's name.							visible	nil	string (255)
upload_file[file_size]	Size	The file's size.							visible	nil	integer (4)
upload_file[id]	File ID	The ID of the associated upload_file.							visible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
upload_file[lock_version]	File Lock Version	The lock_version of the associated upload_file.							visible	0	integer (4)
upload_file_id	Upload file	Foreign key for upload_file							invisible	nil	integer (4)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
resource	Resource	The resource that the file is attached to.	Private::Activity::Task Private::Activity::Meeting Private::AssetLibrary::Asset Private::Email Private::MailShot Private::ImpFile Private::Note Private::GoogleDocNote Private::OutputDocumentImage Private::OutputDocumentTemplate	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1
upload_file	Upload file	The file attached to this resource.	Private::UploadFile	belongs_to	upload_file_id	1

Campaign Membership Status

Class Private::Crm::CampaignMembershipStatus

Campaign Membership Status

See the help on Campaign Membership Statuses for more details.

API URLs

API requests for this model should be directed to crm/campaign_membership_status.api

The full metadata for this model can be obtained by an API client using the URL crm/campaign_membership_status/metadata.api

Mandatory Fields

This model has mandatory fields:

Campaign (marketing_campaign_id)
Status (status)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The campaign membership status descriptor							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
marketing_campaign[name]	Campaign	The name of the Campaign that this Status is related to.							visible	nil	string (255)
marketing_campaign_id	Campaign	Foreign key for marketing_campaign							invisible	nil	integer (4)
status	Status	The status of the Campaign.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
marketing_campaign	Campaign	The Campaign that this Status is related to.	Private::Crm::MarketingCampaign	belongs_to	marketing_campaign_id	1
members	Members	The members of this Campaign with this Status.	Private::Crm::CampaignMembership	has_many	campaign_membership_status_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Campaign Membership

Class Private::Crm::CampaignMembership

Campaign Membership

This model also supports an additional endpoint "crm/campaign_membership/update_mailer_email_actions.api" for updating campaign member email actions. This maybe useful for updating large volumes of campaign members efficiently. It is restricted to updating the following fields.

email_sent
email_soft_bounced
email_hard_bounced
email_opens
email_last_opened
email_clicks
email_last_clicked
email_campaign_unsubscribe

URL: crm/campaign_membership/update_mailer_email_actions.api

HTTP method: PUT

Parameters: Takes the following array based request parameters up to a maximum size of 500 elements each. All parameters are required and should all contain the same number of elements.

campaign_member_ids - an array of campaign_member_ids integers
sent - an array of booleans
soft_bounced - an array of booleans
hard_bounced - an array of booleans
opens - an array of integers
last_opens - an array of date strings
clicks - an array of integers
last_clicks - an array of date strings
email_campaign_unsubscribe - an array of booleans

curl example

curl -ssl -1 -i -g -s --insecure \
-b '/tmp/cookiejar' \
-X 'PUT' \
-d '_authenticity_token={AUTHENTICITY TOKEN FROM YOUR LOGIN}' \
-d '_method[]=PUT' \
-d 'campaign_member_ids[]={YOUR CAMPAIGN MEMBER ID 1}' \
-d 'campaign_member_ids[]={YOUR CAMPAIGN MEMBER ID 2}' \
-d 'campaign_member_ids[]={YOUR CAMPAIGN MEMBER ID 3}' \
-d 'campaign_member_ids[]={YOUR CAMPAIGN MEMBER ID 4}' \
-d 'sent[]=true' \
-d 'sent[]=true' \
-d 'sent[]=true' \
-d 'sent[]=true' \
-d 'soft_bounced[]=false' \
-d 'soft_bounced[]=true' \
-d 'soft_bounced[]=false' \
-d 'soft_bounced[]=false' \
-d 'hard_bounced[]=false' \
-d 'hard_bounced[]=false' \
-d 'hard_bounced[]=false' \
-d 'hard_bounced[]=false' \
-d 'opens[]=2' \
-d 'opens[]=0' \
-d 'opens[]=2' \
-d 'opens[]=1' \
-d 'last_opens[]=Fri May 15 14:36:54 UTC 2014' \
-d 'last_opens[]=' \
-d 'last_opens[]=Fri May 15 14:36:54 UTC 2014' \
-d 'last_opens[]=Fri May 18 08:36:54 UTC 2014' \
-d 'clicks[]=2' \
-d 'clicks[]=0' \
-d 'clicks[]=2' \
-d 'clicks[]=0' \
-d 'last_clicks[]=Fri May 15 14:36:58 UTC 2014' \
-d 'last_clicks[]=' \
-d 'last_clicks[]=Fri May 15 14:36:58 UTC 2014' \
-d 'last_clicks[]=Fri May 18 08:36:14 UTC 2014' \
-d 'email_campaign_unsubscribe[]=false' \
-d 'email_campaign_unsubscribe[]=false' \
-d 'email_campaign_unsubscribe[]=false' \
-d 'email_campaign_unsubscribe[]=true' \
https://secure.workbooks.com/crm/campaign_membership/update_mailer_email_actions.api 2>&1

See the help on Campaign Memberships for more details.

API URLs

API requests for this model should be directed to crm/campaign_membership.api

The full metadata for this model can be obtained by an API client using the URL crm/campaign_membership/metadata.api

Mandatory Fields

This model has mandatory fields:

Member name (member_name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
campaign_membership_status_id	Campaign membership status	Foreign key for member_status							invisible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The campaign membership descriptor							visible	nil	string (255)
email	Email Address	The email address of the party or sales lead							visible	nil	string (255)
email_campaign_unsubscribe	Campaign Email Opt Out	Has the member opted out of email as a result of the campaign email							visible	false	boolean (1)
email_clicks	Email Clicks	Number of email clicks							visible	0	integer (4)
email_hard_bounced	Email Hard Bounced	The email was hard bounced							visible	false	boolean (1)
email_last_clicked	Last Email Click	When an email link was last clicked							visible	nil	datetime
email_last_opened	Last Email Open	When an email was last opened							visible	nil	datetime
email_opens	Email Opens	Number of email opens							visible	0	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
email_sent	Email Sent	An email was sent							visible	false	boolean (1)
email_soft_bounced	Email Soft Bounced	The email was soft bounced							visible	false	boolean (1)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
marketing_campaign[mailing_list][public_name]	Public name	The public name of the Marketing Campaign visible to recipients of mailshot emails							visible	nil	string (255)
marketing_campaign[name]	Campaign Name	The name of the Marketing Campaign							visible	nil	string (255)
marketing_campaign_id	Marketing Campaign ID	Foreign key for the Marketing Campaign.							invisible	nil	integer (4)
member_name	Member name	The name of the campaign member							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
member_status[status]	Status	Status of the Member within the Campaign							visible	nil	string (255)
party_or_lead_id	Party or Lead ID	The ID of the party or sales lead							invisible	nil	integer (4)
party_or_lead_type	Party or Lead type	The type of the party or sales lead, People or Sales Leads							invisible	nil	string (255)
subscribed	Subscribed to email	Is the member subscribed to email from the marketing campaign?							visible	true	boolean (1)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
lead	Lead	The sales lead whose Campaign Membership Status this is	Private::Crm::SalesLead	belongs_to	party_or_lead_id	1
marketing_campaign	Campaign	The Campaign that this campaign member is a member of	Private::Crm::MarketingCampaign	belongs_to	marketing_campaign_id	1
member_status	Member Status	The status of this member within the Campaign	Private::Crm::CampaignMembershipStatus	belongs_to	campaign_membership_status_id	1
organisation	Organisation	The organisation whose Campaign Membership Status this is	Private::Crm::Organisation	belongs_to	party_or_lead_id	1
person	Person	The person whose Campaign Membership Status this is	Private::Crm::Person	belongs_to	party_or_lead_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Case Queue

Class Private::Crm::CaseQueue

A list of Cases assigned to a waiting list

API URLs

API requests for this model should be directed to crm/case_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/case_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
cases	Cases	The set of Cases on this queue.	Private::Crm::Case	has_many	case_queue_id	queue_entries	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::CaseQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Case

Class Private::Crm::Case

Support issues between your own organisation and other parties (either people or organisations)

See the help on Cases for more details.

API URLs

API requests for this model should be directed to crm/cases.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/cases/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Status (case_status_id)
Summary (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
assigned_to	Assigned to	A picklist of queues that this Case could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Case Queues (Private::Crm::CaseQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_Case/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
case_priority[value]	Priority	The priority of this Case.							visible	nil	string (255)
case_priority_id	Priority	The priority of this Case.							invisible	nil	integer (4)	Picklist: Case Priorities Picklist id: 33 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
case_source[value]	Source	The source of this Case.							visible	nil	string (255)
case_source_id	Source	The source of this Case.							invisible	nil	string (255)	Picklist: Case Sources Picklist id: 36 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
case_status[value]	Status	The status of this Case.							visible	nil	string (255)
case_status_id	Status	The status of this Case.							invisible	nil	string (255)	Picklist: Case Statuses Picklist id: 35 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
case_type[value]	Type	The type of this Case.							visible	nil	string (255)
case_type_id	Type	The type of this Case.							invisible	nil	integer (4)	Picklist: Case Types Picklist id: 37 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
contact_email	Contact email	The email address of the Contact.							visible	nil	string (255)
contact_person_id	Contact ID	The ID of the Person to contact regarding this Case.							invisible	nil	integer (4)	Linked item: primary_contact_linked_item Title: Primary contact Linked classes: People (Private::Crm::Person) Association: person Value field: id Display field: name Path: /picklist_data/Private_Crm_Case/id/name.wbjson?_linked_item_name=contact_person_id Return fields: [ special_requirements, employer_name, website, type, preferred_language, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
contact_phone_number	Contact telephone	The phone number of the Contact.							visible	nil	string (255)
contract[end_date]	Contract end date	The end date of the related Contract.							visible	nil	date
contract[object_ref]	Contract object ref	The object reference of the related Contract.							visible	nil	string (255)
contract[start_date]	Contract start date	The start date of the related Contract.							visible	nil	date
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
contract[status]	Contract status	The status of the related Contract.							visible	nil	string (255)
contract_id	Contract	Foreign key for contract							invisible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Object reference and name	Combined object reference and name of the case.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Summary	A one-line summary of the issue that this Case will address.							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
person[employer][id]	Contact employer id	The id of the Employer of the Contact.							visible	nil	integer (4)
person[employer][name]	Contact employer	The name of the Employer of the Contact.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
person[name]	Contact name	The name of the Person to contact regarding this Case.							visible	nil	string (255)
person[preferred_language]	Contact preferred language	The Contact's preferred language.							visible	nil	string (255)	Picklist: Languages Picklist id: 29 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person[special_requirements]	Contact special requirements	Any special requirements that the Contact has.							visible	nil	string (255)	Picklist: Party Special Requirements Picklist id: 28 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
problem	Description	A full description of the issue.							visible	nil	text (16777215)
product_category[value]	Product category	The Product category that this Case is related to.							visible	nil	string (255)
product_category_id	Product category	The Product category that this Case is related to.							invisible	nil	string (255)	Picklist: Product Categories Picklist id: 5 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
queue_entry[queue][name]	Assigned to name	The name of the queue that this Case is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Case is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Case was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
resolution	Resolution description	A full description of how the issue will be or was resolved.							visible	nil	text (16777215)
resolution_status[value]	Resolution status	The resolution status of this Case.							visible	nil	string (255)
resolution_status_id	Resolution status	The resolution status of this Case.							invisible	nil	integer (4)	Picklist: Case Resolution Statuses Picklist id: 31 Class: Picklist Entries (Private::PicklistEntry) Value field: id Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/id/value.wbjson Return fields: []
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	The Activities that are related to this Case.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Case.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Case could be assigned to.	Private::Crm::CaseQueue	has_one	assigned_to		1	1
contract	Contract	The Contract related to this Case.	Private::Accounting::Contract	belongs_to	contract_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
person	Contact	The Person to contact regarding this Case.	Private::Crm::Person	belongs_to	contact_person_id		0	1
queue	Assigned to	The Queue that this Case is assigned to.	Private::Crm::CaseQueue	has_one	case_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Case to the Queue.	Private::Crm::CaseQueueEntry	has_one	case_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Custom Field

Class Private::CustomField

Allows Workbooks to be extended by adding additional custom fields to certain record types.

See the help on Custom Fields for more details.

API URLs

API requests for this model should be directed to admin/custom_fields.api

The full metadata for this model can be obtained by an API client using the URL admin/custom_fields/metadata.api

Mandatory Fields

This model has mandatory fields:

Data type (data_type)
Resource type (resource_type)
Title (title)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
data_type	Data type	The data type of the custom field on the 'resource_type' class. Valid data types are listed on the resource types class documentation. See the 'resource_type' attribute for a list of resource types that support custom fields.							visible	"string"	string (255)
default_height	Default height	Default height is relevant and required for 'text' and 'iframe' data type custom fields. For 'text' this must be a number between 200 and 500. For 'iframe' this must be a number between 28 and 2500.							visible	nil	integer (4)
default_value_boolean	Default value boolean	The default value of a boolean custom field.							visible	nil	boolean (1)
default_value_currency	Default value currency	The default value of a currency custom field.							visible	£0.00	currency (63,5)
default_value_date	Default value date	The default value of a date custom field.							visible	nil	date
default_value_datetime	Default value datetime	The default value of a datetime custom field.							visible	nil	datetime
default_value_decimal	Default value decimal	The default value of a decimal custom field.							visible	nil	decimal (63,5)
default_value_email_link	Default value email link	The default value of a email link custom field.							visible	nil	string (255)
default_value_integer	Default value integer	The default value of an integer custom field.							visible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
default_value_linkable	Default value linkable	The default value of a linkable custom field.							visible	nil	text (65535)
default_value_multiline	Default value multiline	The default value of a multiline custom field.							visible	nil	text (65535)
default_value_percentage	Default value percentage	The default value of a percentage custom field.							visible	nil	decimal (63,5)
default_value_phone_link	Default value phone link	The default value of a phone link custom field.							visible	nil	string (255)
default_value_picklist	Default value picklist	The default value of a picklist custom field.							visible	nil	string (255)
default_value_string	Default value string	The default value of a string custom field.							visible	nil	string (255)
default_value_tagarray	Default value tagarray	The default values of a multiselect custom field.							visible	nil	text (65535)
default_value_text	Default value text	The default value of a text custom field.							visible	nil	text (65535)
default_value_time	Default value time	The default value of a time custom field.							visible	nil	time
display_full_width	Display full width	Boolean specifying if the custom field should be displayed full width. Only applicable when the 'resource_type' has more than 1 display_position							visible	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
display_order	Display order	The display order of the custom field within the display position.							visible	1	integer (3)
display_position	Display position	The display position of the custom field on resource type records. Valid display positions are listed on the resource types class documentation.							visible	1	integer (1)
id	Id	The id of this object.							hidden	nil	integer (4)
is_indexed	Is indexed	Boolean specifying if the custom field is indexed. Valid for custom fields with the following data types string, picklist, linkable, email_link, phone_link, boolean, integer, decimal, date, time, datetime, tagarray and percentage.							visible	false	boolean (1)
is_searchable	Is searchable	Boolean specifying if the custom field is searchable in the desktop search. Valid for custom fields with the following data types string, integer, text, multiline, email_link and phone_link.							visible	false	boolean (1)
linked_url	Linked URL	URL of an IFrame or URL custom field							visible	nil	text (65535)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
maximum	Maximum	The maximum value of a percentage custom field.							visible	nil	decimal (63,5)
min_height	Min height	Minimum height is relevant and required for 'text' and 'iframe' data type custom fields. For 'text' this must be a number between 200 and 500. For 'iframe' this must be a number between 28 and 2500.							visible	nil	integer (4)
minimum	Minimum	The minimum value of a percentage custom field.							visible	nil	decimal (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
name	Name	The name of the custom field.							visible	nil	string (255)
picklist_id	Picklist ID	The id of the picklist that provides the values for a picklist custom field.							visible	nil	integer (4)
read_only	Read Only	Boolean specifying if the custom field is read only on a resource type record.							visible	false	boolean (1)
required	Required	Boolean specifying if the custom field is a required field on a resource type record.							visible	false	boolean (1)
resource_type	Resource type	The Workbooks record type the custom field is defined on. The following classes support custom fields Cases, Customer Contracts, Customer Credit Notes, Customer Invoices, Customer Orders, Customer Quotations, Marketing Campaigns, Meetings, Opportunities, Organisations, Party Relationships, People, Products, Sales Leads, Supplier Orders and Tasks							visible	nil	string (255)
show_button	Show button	Boolean specifying if a IFrame custom field should have a show button.							visible	true	boolean (1)
show_by_default	Show by default	Boolean specifying if the the custom field should be shown by default.							visible	true	boolean (1)
show_in_grid	Show in grids	Boolean specifying if the custom field should be shown in grids of resource type records.							visible	true	boolean (1)
show_on_tab	Show on Tab	Boolean specifying if the the custom field will be displayed by itself, on an additional tab, rather than on the main tab. Only applicable to the following data types iframe.							visible	false	boolean (1)
string_width	String width	The width of string based custom fields. Valid for custom fields with the following data types string, picklist, linkable, email_link and phone_link.							visible	50	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
tagarray_id	Tagarray ID	The id of the picklist that provides the values for a multiselect custom field.							visible	nil	integer (4)
title	Title	The title of the custom field.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
value_column_name	Value column name	The name of the custom field attribute on resource type records.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Polymorphic?	Foreign key	Through	Min. items	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to		created_by		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to		updated_by		0	1

Customer Contract Line Item

Class Private::Accounting::ContractLineItem

Line Items belonging to Customer Contracts

See the help on Customer Contract Line Items for more details.

API URLs

API requests for this model should be directed to accounting/contract_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/contract_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit price (document currency) (document_currency_unit_price_value)
End Date (end_date)
Start Date (start_date)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Contract Line Item Statuses Picklist id: 51 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
contract_document	Customer Contract	The Customer Contract that this Line Item belongs to.	Private::Accounting::Contract	belongs_to	document_header_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Customer Contract Queue

Class Private::Accounting::ContractQueue

A list of Customer Contracts assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/contract_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/contract_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
contracts	Contracts	The set of Customer Contracts on this queue.	Private::Accounting::Contract	has_many	contract_queue_id	queue_entries	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::ContractQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Customer Contract

Class Private::Accounting::Contract

Contracts for your customers for services

See the help on Customer Contracts for more details.

API URLs

API requests for this model should be directed to accounting/contracts.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/contracts/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Customer Contract Name (description)
Document Currency (document_currency)
Customer Contract Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Customer Contract could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Customer Contract Queues (Private::Accounting::ContractQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_Contract/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
contract_type	Contract Type	The Type of Contract							visible	nil	string (255)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Customer Contract Name	The description of this Customer Contract.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Customer Contract Date	The official date for this Customer Contract.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
end_date	Contract End Date	The end date of the Contract							visible	nil	date
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Contract Synchronised	A boolean set to true if this contract has been synchronised to a third party service.							visible	nil	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_Contract/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_Contract/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Customer Contract is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Customer Contract is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Customer Contract was assigned.							visible	nil	datetime
start_date	Contract Start Date	The start date of the Contract							visible	nil	date
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Customer Contract could be assigned to.	Private::Accounting::ContractQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
cases	Cases	The Cases that are related to the Contract.	Private::Crm::Case	has_many	contract_id		0	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Customer Contract.	Private::Accounting::ContractLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Customer	The Customer for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Customer (organisation)	The Customer Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Customer (person)	The Customer Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Customer Contract is assigned to.	Private::Accounting::ContractQueue	has_one	contract_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Customer Contract to the Queue.	Private::Accounting::ContractQueueEntry	has_one	contract_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Customer Credit Note Line Item

Class Private::Accounting::CreditNoteLineItem

Line Items belonging to Customer Credit Notes

See the help on Customer Credit Note Line Items for more details.

API URLs

API requests for this model should be directed to accounting/credit_note_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/credit_note_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit price (document currency) (document_currency_unit_price_value)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Credit Note Line Item Statuses Picklist id: 52 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
credit_note_document	Customer Credit Note	The Customer Credit Note that this Line Item belongs to.	Private::Accounting::CreditNote	belongs_to	document_header_id	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Customer Credit Note Queue

Class Private::Accounting::CreditNoteQueue

A list of Customer Credit Notes assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/credit_note_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/credit_note_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
credit_notes	Credit notes	The set of Customer Credit Notes on this queue.	Private::Accounting::CreditNote	has_many	credit_note_queue_id	queue_entries	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::CreditNoteQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Customer Credit Note

Class Private::Accounting::CreditNote

Credits given to a customer, often as a result of an invoice error or dispute

See the help on Customer Credit Notes for more details.

API URLs

API requests for this model should be directed to accounting/credit_notes.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/credit_notes/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Customer Credit Note Name (description)
Document Currency (document_currency)
Customer Credit Note Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
amount_outstanding	Amount Outstanding	The outstanding amount on this Credit Note.							visible	£0.00	currency (63,5)
amount_paid	Amount Paid	The amount paid against this Credit Note.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
assigned_to	Assigned to	A picklist of queues that this Customer Credit Note could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Customer Credit Note Queues (Private::Accounting::CreditNoteQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_CreditNote/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Customer Credit Note Name	The description of this Credit Note.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Customer Credit Note Date	The official date for this Credit Note.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Credit Note Synchronised	A boolean set to true if this Credit Note has been synchronised to a third party service.							visible	nil	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_CreditNote/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_CreditNote/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
queue_entry[queue][name]	Assigned to name	The name of the queue that this Customer Credit Note is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Customer Credit Note is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Customer Credit Note was assigned.							visible	nil	datetime
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Customer Credit Note could be assigned to.	Private::Accounting::CreditNoteQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Customer Credit Note.	Private::Accounting::CreditNoteLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Customer	The Customer for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Customer (organisation)	The Customer Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Customer (person)	The Customer Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Customer Credit Note is assigned to.	Private::Accounting::CreditNoteQueue	has_one	credit_note_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Customer Credit Note to the Queue.	Private::Accounting::CreditNoteQueueEntry	has_one	credit_note_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Customer Invoice Line Item

Class Private::Accounting::InvoiceLineItem

Line Items belonging to Customer Invoices

See the help on Customer Invoice Line Items for more details.

API URLs

API requests for this model should be directed to accounting/invoice_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/invoice_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Required (#10867) (cf_required_10867_8)
Unit price (document currency) (document_currency_unit_price_value)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for invoice_document							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Invoice Line Item Statuses Picklist id: 53 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
invoice_document	Customer Invoice	The Customer Invoice that this Line Item belongs to.	Private::Accounting::Invoice	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Customer Invoice Queue

Class Private::Accounting::InvoiceQueue

A list of Customer Invoices assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/invoice_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/invoice_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
invoices	Invoices	The set of Customer Invoices on this queue.	Private::Accounting::Invoice	has_many	invoice_queue_id	queue_entries	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::InvoiceQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Customer Invoice

Class Private::Accounting::Invoice

Invoices to a customer as a result of supply of goods or services

See the help on Customer Invoices for more details.

API URLs

API requests for this model should be directed to accounting/invoices.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/invoices/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Partner status (cf_partner_status_5)
Invoice Name (description)
Document Currency (document_currency)
Invoice Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
amount_outstanding	Amount Outstanding	The outstanding amount on this Invoice.							visible	£0.00	currency (63,5)
amount_paid	Amount Paid	The amount paid against this Invoice.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
assigned_to	Assigned to	A picklist of queues that this Customer Invoice could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Customer Invoice Queues (Private::Accounting::InvoiceQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_Invoice/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Invoice Name	The description of this Invoice.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Invoice Date	The official date for this Invoice.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Invoice Synchronised	A boolean set to true if this invoice has been synchronised to a third party service.							visible	nil	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Invoice Number	The document Number for this Invoice.							visible	nil	string (255)
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_Invoice/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_Invoice/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
queue_entry[queue][name]	Assigned to name	The name of the queue that this Customer Invoice is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Customer Invoice is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Customer Invoice was assigned.							visible	nil	datetime
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Customer Invoice could be assigned to.	Private::Accounting::InvoiceQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Customer Invoice.	Private::Accounting::InvoiceLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Customer	The Customer for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Customer (organisation)	The Customer Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Customer (person)	The Customer Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Customer Invoice is assigned to.	Private::Accounting::InvoiceQueue	has_one	invoice_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Customer Invoice to the Queue.	Private::Accounting::InvoiceQueueEntry	has_one	invoice_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Customer Order Line Item

Class Private::Accounting::SalesOrderLineItem

Line Items belonging to Customer Orders

See the help on Customer Order Line Items for more details.

API URLs

API requests for this model should be directed to accounting/sales_order_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/sales_order_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit price (document currency) (document_currency_unit_price_value)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Customer Order Line Item Statuses Picklist id: 54 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
sales_order_document	Customer Order	The Customer Order that this Line Item belongs to.	Private::Accounting::SalesOrder	belongs_to	document_header_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Customer Order Queue

Class Private::Accounting::SalesOrderQueue

A list of Customer Orders assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/sales_order_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/sales_order_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::SalesOrderQueueEntry	has_many	queue_id		Infinity
sales_orders	Sales orders	The set of Customer Orders on this queue.	Private::Accounting::SalesOrder	has_many	sales_order_queue_id	queue_entries	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Customer Order

Class Private::Accounting::SalesOrder

Orders from your customers for your goods or services

See the help on Customer Orders for more details.

API URLs

API requests for this model should be directed to accounting/sales_orders.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/sales_orders/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Customer Order Name (description)
Document Currency (document_currency)
Customer Order Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Customer Order could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Customer Order Queues (Private::Accounting::SalesOrderQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_SalesOrder/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
description	Customer Order Name	The description of this Customer Order.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Customer Order Date	The official date for this Customer Order.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Sales Order Synchronised	A boolean set to true if this sales order has been synchronised to a third party service.							visible	nil	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_SalesOrder/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_SalesOrder/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
queue_entry[queue][name]	Assigned to name	The name of the queue that this Customer Order is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Customer Order is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Customer Order was assigned.							visible	nil	datetime
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Customer Order could be assigned to.	Private::Accounting::SalesOrderQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Customer Order.	Private::Accounting::SalesOrderLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Customer	The Customer for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Customer (organisation)	The Customer Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Customer (person)	The Customer Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Customer Order is assigned to.	Private::Accounting::SalesOrderQueue	has_one	sales_order_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Customer Order to the Queue.	Private::Accounting::SalesOrderQueueEntry	has_one	sales_order_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Customer Quotation Line Item

Class Private::Accounting::QuotationLineItem

Line Items belonging to Customer Quotations

See the help on Customer Quotation Line Items for more details.

API URLs

API requests for this model should be directed to accounting/quotation_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/quotation_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit price (document currency) (document_currency_unit_price_value)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Quotation Line Item Statuses Picklist id: 56 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
quotation_document	Customer Quotation	The Customer Quotation that this Line Item belongs to.	Private::Accounting::Quotation	belongs_to	document_header_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Customer Quotation Queue

Class Private::Accounting::QuotationQueue

A list of Customer Quotations assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/quotation_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/quotation_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::QuotationQueueEntry	has_many	queue_id		Infinity
quotations	Quotations	The set of Customer Quotations on this queue.	Private::Accounting::Quotation	has_many	quotation_queue_id	queue_entries	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Customer Quotation

Class Private::Accounting::Quotation

Quotations to an organisation in anticipated supply of goods or services

See the help on Customer Quotations for more details.

API URLs

API requests for this model should be directed to accounting/quotations.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/quotations/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Customer Quotation Name (description)
Document Currency (document_currency)
Customer Quotation Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Customer Quotation could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Customer Quotation Queues (Private::Accounting::QuotationQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_Quotation/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
description	Customer Quotation Name	The description of this Quote.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Customer Quotation Date	The official date for this Quote.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Quotation Synchronised	A boolean set to true if this quotation has been synchronised to a third party service.							visible	nil	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_Quotation/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_Quotation/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
queue_entry[queue][name]	Assigned to name	The name of the queue that this Customer Quotation is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Customer Quotation is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Customer Quotation was assigned.							visible	nil	datetime
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Customer Quotation could be assigned to.	Private::Accounting::QuotationQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Customer Quotation.	Private::Accounting::QuotationLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Customer	The Customer for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Customer (organisation)	The Customer Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Customer (person)	The Customer Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Customer Quotation is assigned to.	Private::Accounting::QuotationQueue	has_one	quotation_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Customer Quotation to the Queue.	Private::Accounting::QuotationQueueEntry	has_one	quotation_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Dashboard Entry

Class Private::DashboardEntry

A dashboard entry

See the help on Dashboard Entries for more details.

API URLs

API requests for this model should be directed to dashboard_entry.api

The full metadata for this model can be obtained by an API client using the URL dashboard_entry/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
chart_configuration_id	Chart configuration id	The id of the chart_configuration used by this dashboard entry.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
dashboard[name]	Dashboard name	The name of the dashboard this entry belongs to.							visible	nil	string (255)
dashboard_id	Dashboard	Foreign key for dashboard							invisible	nil	integer (4)
data_view_id	Data view id	The id of the data view used by this dashboard entry.							visible	nil	integer (4)
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the dashboard entry.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
dashboard	Dashboard	The dashboard that this entry belongs to	Private::Dashboard	belongs_to	dashboard_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Dashboard

Class Private::Dashboard

Overview of information in the system

See the help on Dashboards for more details.

API URLs

API requests for this model should be directed to dashboard.api

The full metadata for this model can be obtained by an API client using the URL dashboard/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the dashboard.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
dashboard_entries	Dashboard entries	Dashboard entries that belong to this dashboard.	Private::DashboardEntry	has_many	dashboard_id	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Document Contact

Class Private::Accounting::DocumentHeaderContact

A relationship between a Document and a Person or Organisation

API URLs

API requests for this model should be directed to accounting/document_header_contacts.api

The full metadata for this model can be obtained by an API client using the URL accounting/document_header_contacts/metadata.api

Mandatory Fields

This model has mandatory fields:

Relationship (document_header_contact_role)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	nil	string (255)
descriptor	Descriptor	The document header contacts descriptor.							visible	nil	string (255)
document_header[description]	Document Name	The transaction document name							visible	nil	string (255)
document_header[document_date]	Document Date	The official date for the transaction document							visible	nil	date
document_header[object_ref]	Document Reference	The transaction document reference							visible	nil	string (255)
document_header[party_name]	Customer Name	The name of the Customer for the transaction document							visible	nil	string (255)
document_header[type]	Document Type	The type of the transaction document							visible	nil	string (255)
document_header_contact_role	Relationship	Relationship between the Document and the Contact							visible	nil	string (255)
document_header_contact_status	Status	The Contact's opinion of their Relationship with the Document							visible	""	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
party_id	Party	Foreign key for person							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Document header	Document related to the Person or Organisation	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
organisation	Related Organisation	Organisation related to the Document	Private::Crm::Organisation	belongs_to	party_id	1
party	Related Party	Party related to the Document	Private::Crm::Party	belongs_to	party_id	1
person	Related Person	Person related to the Document	Private::Crm::Person	belongs_to	party_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Document Relationship

Class Private::Accounting::DocumentHeaderRelationship

A relationship between two transaction documents

API URLs

API requests for this model should be directed to accounting/document_header_relationships.api

The full metadata for this model can be obtained by an API client using the URL accounting/document_header_relationships/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The document header relationship descriptor.							visible	nil	string (255)
document_header_id	Document header	Foreign key for document_header							invisible	nil	integer (4)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
related_document_header_id	Related document header	Foreign key for related_document_header							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Transaction Document	The transaction document with relationships.	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
related_document_header	Related Transaction Document	The related transaction document.	Private::Accounting::DocumentHeader	belongs_to	related_document_header_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Email

Class Private::Email

Emails sent from Workbooks or received via a dropbox or Outlook

See the help on Emails for more details.

API URLs

API requests for this model should be directed to email/emails.api

The full metadata for this model can be obtained by an API client using the URL email/emails/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
bcc_addresses	Bcc addresses	A comma-separated list of email addresses for the bcc: list							visible	nil	string (255)
cc_addresses	Cc addresses	A comma-separated list of email addresses for the cc: list							visible	nil	string (255)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
dropbox_authorised_sender	Dropbox authorised sender	The address of the authorised sender that the Email was accepted from through the dropbox.							visible	nil	string (255)
error	Error	Any errors on the Email.							visible	nil	text (65535)
from_address	Sender	The email address of the sender of the Email.							visible	nil	string (255)
has_attached_files	Has attachments	Set to true if the Email has attachments.							visible	false	boolean (1)
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
message_id	Message	The SMTP message id.							visible	nil	string (255)
outbox	Being sent	Set to true if the Email is currently being sent.							visible	false	boolean (1)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
render_with_placeholders	Render with placeholders	A JSON-encoded array of strings to substitute into the template specified using render_with_template_id or render_with_template_name.							visible	nil	text (65535)
render_with_resource_id	Render with resource	The ID of an object to be used with a template specified using render_with_template_id or render_with_template_name.							visible	nil	integer (4)
render_with_resource_type	Render with resource type	The full type name of an object to be used with a template specified using render_with_template_id or render_with_template_name.							visible	nil	string (255)
render_with_template_id	Render with template	The ID of an html_template to use to generate the subject and body.							visible	nil	integer (4)
render_with_template_name	Render with template name	The name of an html_template to use to generate the subject and body; this can be used as an alternative to render_with_template_id. The oldest visible template will be used.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
rfc822	Rfc822	The full RFC822 message headers and body. If using this to send an email most other attributes cannot not be set.							visible	nil	text (16777215)
sent	Sent	When the Email was sent.							visible	nil	datetime
status	Status	The status of the Email.							visible	nil	string (255)
subject	Subject	The subject of the Email.							visible	nil	string (998)
synopsis	Synopsis	A snippet from the beginning of the Email.							visible	nil	text (65535)
to_addresses	To addresses	A comma-separated list of email addresses for the to: list							visible	nil	string (255)
to_string	Recipients	A comma-separated list of all the recipients of the Email.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
email_tos	Recipients	The set of recipients of the Email.	Private::EmailTo	has_many	email_id	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

External Link

Class Private::ExternalLinkNote

A link an external web page

See the help on External Links for more details.

API URLs

API requests for this model should be directed to external_link_notes.api

The full metadata for this model can be obtained by an API client using the URL external_link_notes/metadata.api

Mandatory Fields

This model has mandatory fields:

Resource (resource_id)
Subject (subject)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The notes descriptor							visible	nil	string (255)
external_href	External href	The URL of the web page							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
subject	Subject	The subject of the Note							visible	nil	string (255)
text	Text	The body of the Note							visible	""	text (16777215)
type	STI type	Type column that specifies the class of each row.							invisible	"Private::Note"	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
resource	Resource	Parent	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Accounting::PurchaseOrder Private::Crm::MarketingCampaign Private::Crm::Case Private::Crm::PartyRelationship Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::SalesLead Private::Pricebook::Product	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

File

Class Private::UploadFile

Files uploaded to Workbooks

See the help on Files for more details.

API URLs

API requests for this model should be directed to upload_files.api

The full metadata for this model can be obtained by an API client using the URL upload_files/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
data	File Contents	The content of the file.							visible	nil	binary
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
file_content_type	Content type	The Content-Type (MIME type) of the file.							visible	nil	string (255)
file_extension	Extension	The file extension from the filename.							visible	nil	string (255)
file_hash	File MD5 Digest	The MD5 hash of the content of the file.							visible	nil	string (255)
file_name	Filename	The file's name.							visible	nil	string (255)
file_size	Size	The file's size.							visible	nil	integer (4)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Polymorphic?	Foreign key	Through	Min. items	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to		created_by		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to		updated_by		0	1

Google Doc Note

Class Private::GoogleDocNote

A link to a Google Document

See the help on Google Doc Notes for more details.

API URLs

API requests for this model should be directed to google_doc_notes.api

The full metadata for this model can be obtained by an API client using the URL google_doc_notes/metadata.api

Mandatory Fields

This model has mandatory fields:

Resource (resource_id)
Subject (subject)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The notes descriptor							visible	nil	string (255)
google_doc_edit_href	Google doc edit href	The URL of the Google document							visible	nil	string (255)
google_doc_resource_id	Google doc resource	The Google id of the Google document							visible	nil	string (255)
google_doc_type	Google doc type	The type of Google document this GoogleDocNote refers to							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
subject	Subject	The subject of the Note							visible	nil	string (255)
text	Text	The body of the Note							visible	""	text (16777215)
type	STI type	Type column that specifies the class of each row.							invisible	"Private::Note"	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
resource	Resource	Parent	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Accounting::PurchaseOrder Private::Crm::MarketingCampaign Private::Crm::Case Private::Crm::PartyRelationship Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::SalesLead Private::Pricebook::Product	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Integration Process

Class Private::Automation::IntegrationAction

A process invoked to create an Integration page

See the help on Integration Processes for more details.

API URLs

API requests for this model should be directed to automation/integration_actions.api

The full metadata for this model can be obtained by an API client using the URL automation/integration_actions/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)
Purpose (purpose_id)
Identifier (web_identifier)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
authenticated_run_as	Run as (authenticated)	The Id of the User to run the authenticated Integration Process as, this can be set to 0 to configure the process to run as the current User.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the Integration Process.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
published_script	Published Script	A flag to indicate that the Script associated with Integration Process is located in the Script Library.							visible	false	boolean (1)
purpose_id	Purpose	The purpose of the Integration Process.							visible	nil	integer (4)	Picklist: Value field: id Display field: name Data: [ {name => 'System Configuration Panel', id => 2}, {name => 'User Preference Panel', id => 3} ]
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
script_id	Script	Foreign key for script							invisible	nil	integer (4)
script_name	Script Name	The name of the Script associated with Integration Process.							visible	""	string (255)
timeout	Maximum Time	The maximum time to allow this process to run for, in seconds.							visible	60	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
web_identifier	Identifier	The unique identifier of the Integration Process, this value is appended to the end of the URL used to access this process.							visible	nil	string (255)
web_url	URL	The full URL used to access this process.							visible	""	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action_parameters	Action Parameters	Parameters defined for this Integration Process.	Private::Automation::ActionParameter	has_many	action_id	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
script	Script	The Script associated with Integration Process.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Integration State

Class Private::IntegrationState

Integration State of a Workbooks record with an integration that is identified by integration_key

API URLs

API requests for this model should be directed to integration_state.api

The full metadata for this model can be obtained by an API client using the URL integration_state/metadata.api

Mandatory Fields

This model has mandatory fields:

Integration State Key (integration_key)
Record ID (record_id)
Record Type (record_type)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The integration state records descriptor.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
integrated_at	Integrated at	The datetime that the record was last integrated.							visible	nil	datetime
integration_data	Data	Data associated with the integration.							visible	""	text (65535)
integration_key	Integration State Key	A key that uniquely identifies an integration.							visible	nil	string (255)
integration_number	Integration number	A number associated with the record and integration.							visible	0	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
record_id	Record ID	The ID of the Workbooks record the integration state relates to.							invisible	nil	integer (4)
record_type	Record Type	The type of the Workbooks record the integration state relates to.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Polymorphic?	Foreign key	Through	Min. items	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to		created_by		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to		updated_by		0	1

Library Asset

Class Private::AssetLibrary::Asset

Public hosted assets for use in online marketing materials. NOTE: They are exposed in the API solely for the Workbooks Outlook Connector to retrieve customisation packages

See the help on Library Assets for more details.

API URLs

API requests for this model should be directed to asset_library/assets.api

The full metadata for this model can be obtained by an API client using the URL asset_library/assets/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The description of this asset.							visible	nil	text (65535)
descriptor	Descriptor	The assets descriptor							visible	nil	string (255)
file_object[upload_file][file_extension]	File extension	The extension on the filename.							visible	nil	string (255)
file_object[upload_file][file_hash]	File hash	The hash of the file content.							visible	nil	string (255)
file_object[upload_file][file_name]	Filename	The name of the file.							visible	nil	string (255)
file_object[upload_file][file_size]	File size	The size of the file.							visible	nil	integer (4)
id	Id	The id of this object.							hidden	nil	integer (4)
identifier	Identifier	A unique identifier for this asset.							visible	nil	string (255)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Marketing Campaign Queue

Class Private::Crm::MarketingCampaignQueue

A list of Marketing Campaigns assigned to a waiting list

API URLs

API requests for this model should be directed to crm/marketing_campaign_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/marketing_campaign_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
marketing_campaigns	Marketing campaigns	The set of Marketing Campaigns on this queue.	Private::Crm::MarketingCampaign	has_many	marketing_campaign_queue_id	queue_entries	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::MarketingCampaignQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Marketing Campaign

Class Private::Crm::MarketingCampaign

Marketing initiatives to build brand awareness and generate sales leads

See the help on Marketing Campaigns for more details.

API URLs

API requests for this model should be directed to crm/campaigns.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/campaigns/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Campaign name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
assigned_to	Assigned to	A picklist of queues that this Marketing Campaign could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Marketing Campaign Queues (Private::Crm::MarketingCampaignQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_MarketingCampaign/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
budget	Budget	The budget for the Campaign							visible	£0.00	currency (63,5)
category	Type	Category of Campaign							visible	nil	string (255)	Picklist: Campaign Types Picklist id: 23 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
cost_adjustment	Cost Adjustment	Cost adjustment to apply to the Campaign							visible	£0.00	currency (63,5)
created_at	Created at	When this object was created.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
email_integration_key_id	Email integration key	Foreign key for mailer_integration_key							invisible	nil	integer (4)
end_date	End date	The date of the end of the Campaign							visible	nil	date
goals	Goals	Goals for the Campaign							visible	nil	text (65535)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
last_mailer_campaign_update	Last synchronised with email marketing campaign	Datetime last synchronised with the linked email marketing campaign							visible	nil	datetime
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
mailer_campaign_id	Email Marketing Campaign id	ID of the email marketing campaign linked to this Marketing Campaign							visible	nil	string (255)
mailer_campaign_sent	Email Marketing Campaign Sent	The date and time the linked email marketing campaign was sent							visible	nil	datetime
mailer_list_id	Email Marketing List ID	ID of a email marketing list linked to this Marketing Campaign							visible	nil	string (255)
mailing_list[public_name]	Public name	The public name of the Marketing Campaign visible to recipients of mailshot emails							visible	nil	string (255)
name	Campaign name	The name of the Marketing Campaign							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Marketing Campaign is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Marketing Campaign is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Marketing Campaign was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
start_date	Start date	The date of the start of the Campaign							visible	nil	date
status	Status	The status of the campaign: Active, Closed or Planned							visible	nil	string (255)	Picklist: Campaign Statuses Picklist id: 19 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
target_revenue	Target Revenue	The target revenue to achieve from the Campaign							visible	£0.00	currency (63,5)
total_emails_clicked	Total email clicks	Total number of email clicks							visible	0	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
total_emails_hard_bounced	Total emails hard bounced	Total number of emails hard bounced							visible	0	integer (4)
total_emails_opened	Total emails opened	Total number of emails opened							visible	0	integer (4)
total_emails_sent	Total emails sent	Total number of emails sent							visible	0	integer (4)
total_emails_soft_bounced	Total emails soft bounced	Total number of emails soft bounced							visible	0	integer (4)
total_emails_unsubscribed	Total campaign opt outs	Total number of email opt outs as a result of the campaign email							visible	0	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	Activities related to this Campaign	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Campaign	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Marketing Campaign could be assigned to.	Private::Crm::MarketingCampaignQueue	has_one	assigned_to		1	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
members	Members	People, leads and organisations associated with this Campaign	Private::Crm::CampaignMembership	has_many	mailing_list_id		0	Infinity
opportunities	Opportunities	Opportunities generated by this Campaign	Private::Crm::Opportunity	has_many	campaign_id		0	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
queue	Assigned to	The Queue that this Marketing Campaign is assigned to.	Private::Crm::MarketingCampaignQueue	has_one	marketing_campaign_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Marketing Campaign to the Queue.	Private::Crm::MarketingCampaignQueueEntry	has_one	marketing_campaign_id		0	1
sales_leads	Sales leads	Sales leads generated by this Campaign	Private::Crm::SalesLead	has_many	marketing_campaign_id		0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Meeting

Class Private::Activity::Meeting

Planned or historic meetings

See the help on Meetings for more details.

API URLs

API requests for this model should be directed to activity/meetings.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL activity/meetings/metadata.api

Mandatory Fields

This model has mandatory fields:

Priority (activity_priority)
Status (activity_status)
Assigned to (assigned_to)
Start (due_datetime)
End (end_datetime)
Subject (name)
Show Time As (show_time_as)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
activity_priority	Priority	The priority of the activity.							visible	"Medium"	string (255)	Picklist: Activity Priorities Picklist id: 21 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
activity_status	Status	The status of the activity.							visible	"New"	string (255)	Picklist: Activity Statuses Picklist id: 17 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
all_day	All Day	Flag to indicate that the Meeting is an all day event and therefore has no start or end time.							visible	false	boolean (1)
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Activity Queues (Private::Activity::ActivityQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Activity_Meeting/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
cached_activity_attendees	Attendee Names	A comma-separated list of all the attendees for this Meeting.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
created_via_invitation	Created via invitation	When set to true, this meeting was created as a result of an invitation from an external calendar service.							visible	false	boolean (1)
description	Description	The details of the activity.							visible	""	text (16777215)
descriptor	Subject and type	Combined Subject and Type of the activity.							visible	nil	string (255)
due_datetime	Start	The date and time that the activity will start.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
end_datetime	End	The date and time that the activity will finish.							visible	nil	datetime
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_recurrence_placeholder	Is Recurrence Placeholder	A flag that indicates that the current record is a copy of the master and contains no individual changes for a recurring series of Meetings.							visible	false	boolean (1)
location	Location	The location of the meeting.							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Subject	Subject of the activity.							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
original_due_datetime	Reminder minutes	The start datetime for the Meeting as defined by the RRule for a recurring series of Meetings.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
primary_contact[employer_name]	Primary contact employer name	The name of the employer for the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][alternate_email]	Primary contact alternate email address	The alternate email address of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][alternate_telephone]	Primary contact alternate phone number	The alternate telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][email]	Primary contact email address	The email address of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][mobile]	Primary contact mobile number	The mobile number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][telephone]	Primary contact phone number	The telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[name]	Primary contact	The name of the primary contact of the activity.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
primary_contact_id	Primary contact ID	The ID of the primary contact Person or Sales lead.							invisible	nil	integer (4)	Linked item: primary_contact_item_linked_item Title: Primary contact Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty) Association: primary_contact Value field: id Display field: name Path: /picklist_data/Private_Activity_Meeting/id/name.wbjson?_linked_item_name=primary_contact_id Return fields: [ employer_name, website, type, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
primary_contact_type	Primary contact type	Foreign type for primary_contact							invisible	nil	string (255)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Activity is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Activity is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Activity was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
recurring_activity_id	Recurring Master Id	The id of the master record that defines each Meeting for a recurring series of Meetings.							invisible	0	integer (4)
reminder_enabled	Reminder	Boolean set to true if there is a reminder for the current user this activity.							visible	false	boolean (1)
reminder_minutes	Reminder minutes	The number of minutes before the event of the reminder for the current user of the activity.							visible	15	integer (4)
rrule	RRule	The RRule that defines the recurrence pattern as defined by RFC 2445 for a recurring series of Meetings.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
show_time_as	Show Time As	Indicates whether the assigned user is Available/Buys etc.							visible	"Busy"	string (255)	Picklist: Meeting Availability Picklist id: 61 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.	Private::Activity::ActivityQueue	has_one	assigned_to		1	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
primary_contact	Primary contact	The primary contact of the activity.	Private::Crm::Person Private::Crm::PersonLeadParty	belongs_to	primary_contact_id		0	1
queue	Assigned to	The Queue that this Activity is assigned to.	Private::Activity::ActivityQueue	has_one	activity_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Activity to the Queue.	Private::Activity::ActivityQueueEntry	has_one	activity_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Note

Class Private::AbstractNote

Text/Memorandum information and data files

See the help on Notes for more details.

API URLs

API requests for this model should be directed to abstract_notes.api

The full metadata for this model can be obtained by an API client using the URL abstract_notes/metadata.api

Mandatory Fields

This model has mandatory fields:

Resource (resource_id)
Subject (subject)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The notes descriptor							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
subject	Subject	The subject of the Note							visible	nil	string (255)
text	Text	The body of the Note							visible	""	text (16777215)
type	STI type	Type column that specifies the class of each row.							invisible	"Private::Note"	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
resource	Resource	Parent	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Accounting::PurchaseOrder Private::Crm::MarketingCampaign Private::Crm::Case Private::Crm::PartyRelationship Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::SalesLead Private::Pricebook::Product	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Note

Class Private::Note

Text/Memorandum information and data files

See the help on Notes for more details.

API URLs

API requests for this model should be directed to notes.api

The full metadata for this model can be obtained by an API client using the URL notes/metadata.api

Mandatory Fields

This model has mandatory fields:

Resource (resource_id)
Subject (subject)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The notes descriptor							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
subject	Subject	The subject of the Note							visible	nil	string (255)
text	Text	The body of the Note							visible	""	text (16777215)
type	STI type	Type column that specifies the class of each row.							invisible	"Private::Note"	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
resource	Resource	Parent	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Accounting::PurchaseOrder Private::Crm::MarketingCampaign Private::Crm::Case Private::Crm::PartyRelationship Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::SalesLead Private::Pricebook::Product	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Notification

Class Private::Notifications::Notification

A notification to one or more users.

Notifications can be created, but not updated. To send a notification, create a record and specify one or more recipients[user_id] values for the notification to be delivered to.

The list of notifications only returns notifications that are due at the time of the request, and that have not been dismissed by the user or another API client. Therefore, if you create a notification and then attempt to find it, you probably won't, unless you set your own login as one of the recipients.

See the help on Notifications for more details.

API URLs

API requests for this model should be directed to notifications/notifications.api

The full metadata for this model can be obtained by an API client using the URL notifications/notifications/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
event_text	Message	The text of the message.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
notifier_id	Record id	An optional id of a record that the message is related to.							visible	nil	integer (4)
notifier_type	Record type	An optional type of a record that the message is related to.							visible	nil	string (255)
recipients[user_id]	Recipient user id	The id of a user to deliver a notification to.							visible	nil	integer (4)
title	Subject	The subject of the notification message.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
recipients	Recipients	Recipients of the message	Private::Notifications::Recipient	has_many	notification_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

On Change Process Listener

Class Private::Automation::ScheduledActionListener

Defines the Record Types that should trigger the corresponding On Change Process when created, updated or deleted.

See the help on On Change Process Listeners for more details.

API URLs

API requests for this model should be directed to automation/scheduled_action_listeners.api

The full metadata for this model can be obtained by an API client using the URL automation/scheduled_action_listeners/metadata.api

Mandatory Fields

This model has mandatory fields:

Listener Type (listener_type)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
action_id	Action	Foreign key for action							invisible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	Describes the On Change Process Listener using a combination of the listener type class and the name of the Action it relates to.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
listener_type	Listener Type	The Workbooks Record Type to listen for changes. The following classes have been defined as notifiers Cases, Customer Contract Line Items, Customer Contracts, Customer Credit Note Line Items, Customer Credit Notes, Customer Invoice Line Items, Customer Invoices, Customer Order Line Items, Customer Orders, Customer Quotation Line Items, Customer Quotations, Marketing Campaigns, Meetings, Opportunities, Opportunity Line Items, Organisations, Party Relationships, People, Pricing Schemes, Products, Sales Leads, Supplier Order Line Items, Supplier Orders, Supply Schemes and Tasks							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action	Action	The action that this parameter is for.	Private::Automation::OnChangeAction	belongs_to	action_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

On Change Process

Class Private::Automation::OnChangeAction

A process which will run a Workbooks Script in the background triggered by updates to a specific Record Type

See the help on On Change Processes for more details.

API URLs

API requests for this model should be directed to automation/on_change_actions.api

The full metadata for this model can be obtained by an API client using the URL automation/on_change_actions/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the On Change Process.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
published_script	Published Script	A flag to indicate that the Script associated with On Change Process is located in the Script Library.							visible	false	boolean (1)
script_id	Script	Foreign key for script							invisible	nil	integer (4)
script_name	Script Name	The name of the Script associated with On Change Process.							visible	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
timeout	Maximum Time	The maximum time to allow this process to run for, in seconds.							visible	60	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action_parameters	Action Parameters	Parameters defined for this Web Process.	Private::Automation::ActionParameter	has_many	action_id	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
script	Script	The Script associated with Web Process.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Opportunity

Class Private::Crm::Opportunity

Potential Sales for your own organisation

See the help on Opportunities for more details.

API URLs

API requests for this model should be directed to crm/opportunities.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/opportunities/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Opportunity Name (description)
Document Currency (document_currency)
Document date (document_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[full_name]	Close period	The full name of the Accounting Period that this Opportunity closed in.							visible	nil	string (255)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period[thru_date]	Close period end	The date of the end of the Accounting Period that this Opportunity closed in.							visible	nil	date
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
assigned_to	Assigned to	A picklist of queues that this Opportunity could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Opportunity Queues (Private::Crm::OpportunityQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_Opportunity/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
campaign_id	Campaign	Foreign key for marketing_campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Opportunity Name	The description of this Transaction.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Document date	The official date for this Transaction.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
last_updated_at	Last updated at	The date and time when this data was last updated.							visible	nil	datetime
last_updated_by	Last updated by	Foreign key for last_updated_by_user							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
last_updated_by_user[person_name]	Last updated by	The user who last updated the data.							visible	nil	string (255)
lead_source_type	Source	The type of lead source that led to this Opportunity							visible	nil	string (255)	Picklist: Lead Source Types Picklist id: 6 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
opportunity_contact_ids	Opportunity Contact Ids	(DEPRECATED - use DocumentHeaderContacts) The ids of any contacts this Opportunity should be additionally linked with.							visible	[]	array
opportunity_contact_roles	Opportunity Contacts Roles	(DEPRECATED - use DocumentHeaderContacts) The roles of any contacts this Opportunity should be additionally linked with.							visible	[]	array
opportunity_stage[name]	Opportunity Stage	The name of the stage that the Opportunity is at.							visible	nil	string (255)
opportunity_stage_id	Opportunity Stage ID	The ID of the opportunity stage.							invisible	nil	integer (4)	Linked item: opportunity_stage Title: Opportunity Stage Linked classes: Opportunity Stages (Private::Crm::OpportunityStage) Association: opportunity_stage Value field: id Display field: name Path: /picklist_data/Private_Crm_Opportunity/id/name.wbjson?_linked_item_name=opportunity_stage_id Return fields: [ probability ]
opportunity_type	Type	The type of this Opportunity.							visible	nil	string (255)	Picklist: Opportunity Types Picklist id: 18 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Customer	The name of the Customer for this Transaction.							visible	nil	string (255)
party_id	Customer ID	The ID of the Customer Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Customer Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Crm_Opportunity/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Customer Reference	The Customer's reference.							visible	nil	string (255)
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
primary_contact[name]	Prospective customer name	The name of the prospective customer							visible	nil	string (255)
probability	Probability	The probability of this Opportunity							visible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
queue_entry[queue][name]	Assigned to name	The name of the queue that this Opportunity is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Opportunity is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Opportunity was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Customer VAT Number	The VAT number of the Customer of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Opportunity could be assigned to.	Private::Crm::OpportunityQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
close_period	Close period	The Accounting Period that this Opportunity closed in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
last_updated_by_user	Last updated by	The user who last updated the data.	Private::CachedUser	belongs_to	last_updated_by		0	1
marketing_campaign	Marketing campaign	The marketing campaign that this Opportunity came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity_stage	Opportunity Stage	The stage that the Opportunity is at.	Private::Crm::OpportunityStage	belongs_to	opportunity_stage_id		0	1
order_line_items	Line items	The set of line items in this Opportunity.	Private::Crm::OpportunityLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Prospective customer	The Prospective customer for this Opportunity.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Prospective customer (organisation)	The prospective customer (Organisation) for this Opportunity.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Prospective customer (person)	The prospective customer (Person) for this Opportunity.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Opportunity is assigned to.	Private::Crm::OpportunityQueue	has_one	opportunity_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Opportunity to the Queue.	Private::Crm::OpportunityQueueEntry	has_one	opportunity_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Opportunity Line Item

Class Private::Crm::OpportunityLineItem

Line Items belonging to Opportunities

See the help on Opportunity Line Items for more details.

API URLs

API requests for this model should be directed to crm/opportunity_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/opportunity_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit price (document currency) (document_currency_unit_price_value)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
additional_discount_1_percent	Additional Discount 1 %	The additional percentage 1 Discount on this Line Item.							visible	nil	decimal (9,6)
additional_discount_2_percent	Additional Discount 2 %	The additional percentage 2 Discount on this Line Item.							visible	nil	decimal (9,6)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for opportunity							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Opportunity Line Item Statuses Picklist id: 57 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
opportunity	Opportunity	The Opportunity that this Line Item belongs to.	Private::Crm::Opportunity	belongs_to	document_header_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Opportunity Queue

Class Private::Crm::OpportunityQueue

A list of Opportunities assigned to a waiting list

API URLs

API requests for this model should be directed to crm/opportunity_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/opportunity_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
opportunities	Opportunities	The set of Opportunities on this queue.	Private::Crm::Opportunity	has_many	opportunity_queue_id	queue_entries	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::OpportunityQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Opportunity Stage

Class Private::Crm::OpportunityStage

Available Stages for an Opportunity

See the help on Opportunity Stages for more details.

API URLs

API requests for this model should be directed to admin/opportunity_stages.api

The full metadata for this model can be obtained by an API client using the URL admin/opportunity_stages/metadata.api

Mandatory Fields

This model has mandatory fields:

Order (display_order)
Forecast status (forecast_status)
Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
display_order	Order	The display order							visible	nil	integer (4)
forecast_status	Forecast status	The Forecast Status this opportunity stage is mapped to							visible	nil	string (255)	Picklist: Forecast Statuses Picklist id: 9 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the opportunity stage							visible	nil	string (255)
probability	Probability	The probability of this opportunity stage.							visible	nil	integer (4)
record_state	Record state	Defines the record state ('open' or 'closed') of the associated opportunities when the stage is selected.							visible	"open"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
opportunities	Opportunities	Opportunities with this stage	Private::Crm::Opportunity	has_many	opportunity_stage_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Organisation Queue

Class Private::Crm::OrganisationQueue

A list of Organisations assigned to a waiting list

API URLs

API requests for this model should be directed to crm/organisation_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/organisation_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
organisations	Organisations	The set of Organisations on this queue.	Private::Crm::Organisation	has_many	organisation_queue_id	queue_entries	Infinity
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::OrganisationQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Organisation

Class Private::Crm::Organisation

Organisations recorded on your database, e.g Customers, Suppliers, Partners, Competition

See the help on Organisations for more details.

API URLs

API requests for this model should be directed to crm/organisations.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/organisations/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Organisation name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
alternate_names	Alternate Names	Alternative names of the Organisation.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Organisation could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Organisation Queues (Private::Crm::OrganisationQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_Organisation/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
industry	Industry	The industry that this Organisation operates in.							visible	nil	string (255)	Picklist: Industries Picklist id: 7 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_own_org	Is own Organisation	A boolean set to true if this Organisation is an Own Organisation.							visible	false	boolean (1)
lead_source_type	Source	Where the information on this Party came from originally.							visible	nil	string (255)	Picklist: Lead Source Types Picklist id: 6 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
main_location[alternate_email]	Alternate Email	The alternate main email address of this Organisation.							visible	nil	string (255)
main_location[alternate_telephone]	Alternate Telephone	The alternate main telephone number.							visible	nil	string (255)
main_location[country]	Country	The main country.							visible	nil	string (255)	Picklist: Countries Picklist id: 3 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
main_location[county_province_state]	County/State	The main county or state.							visible	nil	string (255)
main_location[email]	Email	The main email address of this Organisation.							visible	nil	string (255)
main_location[fax]	Fax	The main fax number.							visible	nil	string (255)
main_location[mobile]	Mobile	The main mobile number for this Organisation.							visible	nil	string (255)
main_location[postcode]	Postcode/Zipcode	The main postcode or zipcode.							visible	nil	string (255)
main_location[street_address]	Street Address	The main street address.							visible	nil	string (255)
main_location[telephone]	Telephone	The main telephone number.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
main_location[town]	Town or City	The main town or city.							visible	nil	string (255)
main_location_id	Main location	Foreign key for main_location							invisible	nil	integer (4)
marketing_campaign[name]	Campaign	The name of the Marketing Campaign that this Party came from.							visible	nil	string (255)
marketing_campaign_id	Campaign ID	The ID of the Marketing Campaign that discovered this Organisation.							invisible	nil	integer (4)	Picklist: Class: Marketing Campaigns (Private::Crm::MarketingCampaign) Value field: id Display field: name Path: /picklist_data/Private_Crm_MarketingCampaign/id/name.wbjson?find_method=pick_available Return fields: [ mailing_list[public_name] ]
name	Organisation name	The name of this Organisation.							visible	nil	string (255)
no_email_soliciting	No email	A boolean set to true if the Organisation does not want to receive emails.							visible	false	boolean (1)
no_phone_soliciting	No sales calls	A boolean set to true if the Party does not want phone calls.							visible	false	boolean (1)
no_post_soliciting	No postal	A boolean set to true if the Party does not want to receive letters.							visible	false	boolean (1)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
organisation_annual_revenue	Annual Revenue	The annual revenue of this Organisation.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
organisation_category	Category	The category of this Organisation.							visible	nil	string (255)	Picklist: Organisation Categories Picklist id: 40 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: true Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
organisation_company_number	Registration number	The official company number of this Organisation.							visible	nil	string (255)
organisation_num_employees	Number of Employees	The number of employees of this Organisation.							visible	nil	integer (4)
organisation_vat_number	VAT number	The Sales Tax number of this Organisation.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party_notes	Notes	A notes field on the record itself.							visible	nil	text (16777215)
preferred_language	Preferred language	The language that this Organisation prefers to converse in.							visible	nil	string (255)	Picklist: Languages Picklist id: 29 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
queue_entry[queue][name]	Assigned to name	The name of the queue that this Organisation is assigned to.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
queue_entry[queue_id]	Assigned to id	The id of the queue that this Organisation is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Organisation was assigned.							visible	nil	datetime
special_requirements	Special requirements	Any special requirements that this Organisation may have.							visible	nil	string (255)	Picklist: Party Special Requirements Picklist id: 28 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
tax_regime[name]	Tax regime	The Tax Regime that this Own Organisation operates in.							visible	nil	string (255)
tax_regime_id	Tax regime	Foreign key for tax_regime							invisible	nil	integer (4)	Picklist: Class: Tax Regimes (Private::Accounting::TaxRegime) Value field: id Display field: description Path: /picklist_data/Private_Accounting_TaxRegime/id/description.wbjson Return fields: []
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)
website	Website	The address of the website of this Party.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	The Activities that are related to this Party.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Party.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Organisation could be assigned to.	Private::Crm::OrganisationQueue	has_one	assigned_to		1	1
campaign_membership	Campaign Membership	The Organisation's membership to the Campaign	Private::Crm::CampaignMembership	has_many	party_or_lead_id		0	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
main_location	Main location	The main location, containing an address and various contact details.	Private::Crm::Location	belongs_to	main_location_id		0	1
marketing_campaign	Campaign	The Campaign that discovered this Organisation.	Private::Crm::MarketingCampaign	belongs_to	marketing_campaign_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
queue	Assigned to	The Queue that this Organisation is assigned to.	Private::Crm::OrganisationQueue	has_one	organisation_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Organisation to the Queue.	Private::Crm::OrganisationQueueEntry	has_one	organisation_id		0	1
tax_regime	Tax regime	The Tax Regime that this Own Organisation operates in.	Private::Accounting::TaxRegime	belongs_to	tax_regime_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Party Relationship Types

Class Private::Crm::PartyRelationshipType

Definitions of the set of valid relationships between People and Organisations.

See the help on Party Relationship Types for more details.

API URLs

API requests for this model should be directed to admin/party_relationship_types.api

The full metadata for this model can be obtained by an API client using the URL admin/party_relationship_types/metadata.api

Mandatory Fields

This model has mandatory fields:

From Party Phrase (verb) (from_party_phrase)
From Party Role (noun) (from_party_role_name)
From Party Plural Role (from_party_role_name_plural)
From Party type (from_party_type)
Name (name)
Tag (tag)
To Party Phrase (verb) (to_party_phrase)
To Party Role (noun) (to_party_role_name)
To Party Plural Role (to_party_role_name_plural)
To Party type (to_party_type)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of the relationship type							visible	""	text (65535)
display_order	Picklist position	The relative position of this relationship type in picklists.							visible	0	integer (4)
from_party_phrase	From Party Phrase (verb)	The phrase form of the role of the From Party.							visible	""	string (255)
from_party_role_name	From Party Role (noun)	The role of the From Party.							visible	""	string (255)
from_party_role_name_plural	From Party Plural Role	The plural form of the role of the From Party.							visible	""	string (255)
from_party_type	From Party type	The class name of the From Party record.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
inverse_id	Inverse	Foreign key for inverse							invisible	nil	integer (4)
is_for_own_orgs	Is for Own Organisations	Specifies whether this relationship type can be used to create relationships between two Own Organisations.							visible	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
is_for_third_parties	Is for third-parties	Specifies whether this relationship type can be used to create relationships between two third-parties.							visible	true	boolean (1)
is_for_third_party_and_own_org	Is for third-party and Own Organisation	Specifies whether this relationship type can be used to create relationships between a third-party and an Own Organisation.							visible	false	boolean (1)
is_inverse	Is inverse	Set to true if this relationship type is the inverse of another relationship type.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the relationship type							visible	nil	string (255)
pickable	Can create new relationships?	Specifies whether a user can create a relationship from this relationship type in this direction.							visible	true	boolean (1)
special_type	Special type	Specifies additional logic that Workbooks will apply for this relationship type.							visible	""	string (255)
system_required	System required	Set to true if this relationship type is required by Workbooks and cannot be modified or deleted.							visible	false	boolean (1)
tag	Tag	The name of the relationship as used in Reporting - must be unique							visible	nil	string (255)
to_party_phrase	To Party Phrase (verb)	The phrase form of the role of the To Party.							visible	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
to_party_role_name	To Party Role (noun)	The role of the To Party.							visible	""	string (255)
to_party_role_name_plural	To Party Plural Role	The plural form of the role of the To Party.							visible	""	string (255)
to_party_type	To Party type	The class name of the To Party record.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
inverse	Inverse relationship type	The inverse relationship type that forms the opposite direction to this relationship type.	Private::Crm::PartyRelationshipType	belongs_to	inverse_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Party Relationship

Class Private::Crm::PartyRelationship

Relationships between People and Organisations.

See the help on Party Relationships for more details.

API URLs

API requests for this model should be directed to crm/party_relationships.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/party_relationships/metadata.api

Mandatory Fields

This model has mandatory fields:

From Party id (from_party_id)
From Party type (from_party_type)
Relationship type id (party_relationship_type_id)
Status (status)
To Party id (to_party_id)
To Party type (to_party_type)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
comments	Comments	Comments on this relationship.							visible	nil	text (65535)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
customer_credit_limit	Credit limit	The credit limit amount to apply to Invoices.							visible	£0.00	currency (63,5)
customer_credit_limit_days	Credit limit days	The number of days credit limit that this customer has.							visible	nil	integer (4)
customer_credit_limit_enabled	Credit limit enabled	If enabled, the credit limit settings are applied to Invoices from a customer relationship.							visible	false	boolean (1)
customer_credit_limit_warning_percent	Warn at %	Warn when the customer's credit exceeds the specified percentage.							visible	nil	decimal (63,5)
customer_default_invoice_address_id	Customer default invoice address	Foreign key for customer_default_invoice_address							invisible	nil	integer (4)
description	Description	A description of this relationship.							visible	nil	string (255)
from_party[name]	From Party Name	The Name of the Person or Organisation this relationship is From.							visible	nil	string (255)
from_party_formatted_name	Inverse relationship	The role of the From Party to the To Party.							visible	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
from_party_id	From Party id	Id of the Person or Organisation this relationship is From.							invisible	nil	integer (4)
from_party_role_name	From Party role	The role of the From Party.							visible	""	string (255)
from_party_type	From Party type	The class name of the From Party record.							visible	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
inverse_party_relationship_id	Inverse id	Id of the inverse relationship record.							invisible	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
partner_level	Partner level	The level of agreement with this partner.							visible	nil	string (255)	Picklist: Partner Levels Picklist id: 26 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: true Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
partner_type	Partner type	Type of business partner.							visible	nil	string (255)	Picklist: Partner Types Picklist id: 25 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: true Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_relationship_type_id	Relationship type id	Id of the type of this relationship.							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
status	Status	Status of this relationship.							visible	""	string (255)	Picklist: Party Relationship Statuses Picklist id: 30 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supplier_default_order_address_id	Supplier default order address	Foreign key for supplier_default_order_address							invisible	nil	integer (4)
supplier_payment_terms	Payment terms (days)	This supplier expects payment within this number of days.							visible	nil	integer (4)
to_party[name]	To Party Name	The Name of the Person or Organisation this relationship is To.							visible	nil	string (255)
to_party_formatted_name	Relationship	The role of the To Party to the From Party.							visible	""	string (255)
to_party_id	To Party id	Id of the Person or Organisation this relationship is To.							invisible	nil	integer (4)
to_party_role_name	To Party role	The role of the To Party.							visible	""	string (255)
to_party_type	To Party type	The class name of the To Party record.							visible	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
valid_from	Start date	When the relationship is valid from.							visible	nil	date
valid_thru	End date	When the relationship is valid to.							visible	nil	date

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
customer_default_invoice_address	Default invoice address	Default address for invoices for this customer.	Private::Crm::Location	belongs_to	customer_default_invoice_address_id	1
from_party	From Party	The Person or Organisation this relationship is From.	Private::Crm::Party	belongs_to	from_party_id	1
supplier_default_order_address	Default purchase order address	Default address for purchase orders for this supplier.	Private::Crm::Location	belongs_to	supplier_default_order_address_id	1
to_party	To Party	The Person or Organisation this relationship is To.	Private::Crm::Party	belongs_to	to_party_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Person

Class Private::Crm::Person

People recorded in your database, e.g a contact, an employee

See the help on People for more details.

API URLs

API requests for this model should be directed to crm/people.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/people/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Person name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
_link_or_create_employer	Link or create Employer by name	Sets the employer to an Organisation that matches by name, or creates the Organisation if it does not exist.							visible	nil	string (255)
alternate_names	Alternate Names	Alternative names of the Person.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Person could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Person Queues (Private::Crm::PersonQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_Person/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
assistant_name	Assistant Name	The full name of the Person's assistant.							visible	nil	string (255)
assistant_phone	Assistant Phone	The telephone number of the Person's assistant.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
categories	Categories	The categories this Person is a member of.							visible	nil	string (255)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
employer_link	Employer	A picklist of possible employers, set to the current employer.							visible	nil	integer (4)	Linked item: employer_link Title: Employer Linked classes: Organisations (Private::Crm::Organisation) Association: employer_link Value field: id Display field: name Path: /picklist_data/Private_Crm_Person/id/name.wbjson?_linked_item_name=employer_link Return fields: [ organisation_vat_number, website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
employer_name	Employer	The name of the current employer of this Person.							visible	nil	string (255)
home_location[alternate_email]	Home Alternate Email	The alternate home email address of this Person.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_location[alternate_telephone]	Home Alternate Telephone	The alternate home telephone number.							visible	nil	string (255)
home_location[country]	Home Country	The home country.							visible	nil	string (255)	Picklist: Countries Picklist id: 3 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
home_location[county_province_state]	Home County/State	The home county or state.							visible	nil	string (255)
home_location[email]	Home Email	The home email address of this Person.							visible	nil	string (255)
home_location[fax]	Home Fax	The home fax number.							visible	nil	string (255)
home_location[mobile]	Mobile	The home mobile number for this Person.							visible	nil	string (255)
home_location[postcode]	Home Postcode/Zipcode	The home postcode or zipcode.							visible	nil	string (255)
home_location[street_address]	Home Street Address	The home street address.							visible	nil	string (255)
home_location[telephone]	Home Telephone	The home telephone number.							visible	nil	string (255)
home_location[town]	Home Town or City	The home town or city.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
industry	Industry	The industry that this Person operates in.							visible	nil	string (255)	Picklist: Industries Picklist id: 7 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lead_source_type	Source	Where the information on this Party came from originally.							visible	nil	string (255)	Picklist: Lead Source Types Picklist id: 6 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
main_location[alternate_email]	Alternate Email	The alternate main email address of this Person.							visible	nil	string (255)
main_location[alternate_telephone]	Alternate Telephone	The alternate main telephone number.							visible	nil	string (255)
main_location[country]	Country	The main country.							visible	nil	string (255)	Picklist: Countries Picklist id: 3 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
main_location[county_province_state]	County/State	The main county or state.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
main_location[email]	Email	The main email address of this Person.							visible	nil	string (255)
main_location[fax]	Fax	The main fax number.							visible	nil	string (255)
main_location[mobile]	Mobile	The main mobile number for this Person.							visible	nil	string (255)
main_location[postcode]	Postcode/Zipcode	The main postcode or zipcode.							visible	nil	string (255)
main_location[street_address]	Street Address	The main street address.							visible	nil	string (255)
main_location[telephone]	Telephone	The main telephone number.							visible	nil	string (255)
main_location[town]	Town or City	The main town or city.							visible	nil	string (255)
main_location_id	Main location	Foreign key for main_location							invisible	nil	integer (4)
marketing_campaign[name]	Campaign	The name of the Marketing Campaign that this Party came from.							visible	nil	string (255)
marketing_campaign_id	Campaign ID	The ID of the Marketing Campaign that discovered this Person.							invisible	nil	integer (4)	Picklist: Class: Marketing Campaigns (Private::Crm::MarketingCampaign) Value field: id Display field: name Path: /picklist_data/Private_Crm_MarketingCampaign/id/name.wbjson?find_method=pick_available Return fields: [ mailing_list[public_name] ]
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
name	Person name	The Person's name.							visible	nil	string (255)
no_email_soliciting	No email	A boolean set to true if the Person does not want to receive emails.							visible	false	boolean (1)
no_phone_soliciting	No sales calls	A boolean set to true if the Party does not want phone calls.							visible	false	boolean (1)
no_post_soliciting	No postal	A boolean set to true if the Party does not want to receive letters.							visible	false	boolean (1)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
organisation_annual_revenue	Annual Revenue	The annual revenue of this Person.							visible	£0.00	currency (63,5)
organisation_num_employees	Number of Employees	The number of employees of this Person.							visible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_notes	Notes	A notes field on the record itself.							visible	nil	text (16777215)
person_first_name	First name	The first name of this Person.							visible	nil	string (255)
person_job_role	Job role	The job role of the Person - a picklist.							visible	nil	string (255)	Picklist: Person Job Roles Picklist id: 1 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_job_title	Job title	The job title of the Person.							visible	nil	string (255)
person_last_name	Last name	The last name of this Person.							visible	nil	string (255)
person_middle_name	Middle name	The middle name of this Person.							visible	nil	string (255)
person_personal_title	Title	The Person's title.							visible	nil	string (255)	Picklist: Personal Titles Picklist id: 16 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_salutation	Salutation	A salutation that can be used to address this Person.							visible	nil	string (255)
person_suffix	Suffix	The suffix to the name of this Person.							visible	nil	string (255)
preferred_language	Preferred language	The language that this Person prefers to converse in.							visible	nil	string (255)	Picklist: Languages Picklist id: 29 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
queue_entry[queue][name]	Assigned to name	The name of the queue that this Person is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Person is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Person was assigned.							visible	nil	datetime
special_requirements	Special requirements	Any special requirements that this Person may have.							visible	nil	string (255)	Picklist: Party Special Requirements Picklist id: 28 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
spouse_name	Spouse Name	The name of the Person's spouse.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)
website	Website	The address of the website of this Party.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	The Activities that are related to this Party.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Party.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Person could be assigned to.	Private::Crm::PersonQueue	has_one	assigned_to		1	1
campaign_membership	Campaign Membership	The Person's membership to the Campaign	Private::Crm::CampaignMembership	has_many	party_or_lead_id		0	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
employer	Employer (main)	The current employer of this Person.	Private::Crm::Organisation	has_one	abstract_person_id	employer_relationship	0	1
employer_link	Employer	A picklist of possible employers, set to the current employer.	Private::Crm::Organisation	integer	employer_link		1	1
employer_relationship	Employer relationship	The Party Relationship that links this Person to their employer.	Private::Crm::PartyRelationship	has_one	from_party_id		0	1
home_location	Home location	The home address location, containing an address and various contact details.	Private::Crm::Location	has_one	party_id		0	1
main_location	Main location	The main location, containing an address and various contact details.	Private::Crm::Location	belongs_to	main_location_id		0	1
marketing_campaign	Campaign	The Marketing Campaign that discovered this Person.	Private::Crm::MarketingCampaign	belongs_to	marketing_campaign_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
queue	Assigned to	The Queue that this Person is assigned to.	Private::Crm::PersonQueue	has_one	person_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Person to the Queue.	Private::Crm::PersonQueueEntry	has_one	person_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Person Queue

Class Private::Crm::PersonQueue

A list of People assigned to a waiting list

API URLs

API requests for this model should be directed to crm/person_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/person_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
people	People	The set of People on this queue.	Private::Crm::Person	has_many	person_queue_id	queue_entries	Infinity
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::PersonQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Picklist Entry

Class Private::PicklistEntry

Choices for picklists

See the help on Picklist Entries for more details.

API URLs

API requests for this model should be directed to admin/picklist_entries.api

The full metadata for this model can be obtained by an API client using the URL admin/picklist_entries/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
display_order	Name	The display order of the picklist entry							visible	0	integer (4)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
picklist_id	Picklist	Foreign key for picklist							invisible	nil	integer (4)
record_state	Record state	Defines the record state ('open' or 'closed') of the associated record when the picklist entry is selected. Only applicable to system required status picklists.							visible	"open"	string (255)
system_required	System required	Boolean specifying if the picklist entry is system required.							visible	false	boolean (1)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
value	Value	The value of the picklist entry							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
picklist	Picklist	The picklist to which the entry belongs.	Private::Picklist	belongs_to	picklist_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Picklist

Class Private::Picklist

A set of values that make up a picklist

See the help on Picklists for more details.

API URLs

API requests for this model should be directed to admin/picklists.api

The full metadata for this model can be obtained by an API client using the URL admin/picklists/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The description of the picklist							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the picklist							visible	nil	string (255)
system_required	System required	Boolean specifying if the picklist is system required.							visible	false	boolean (1)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unrestricted	Unrestricted	Boolean specifying if the picklist is unrestricted. Unrestricted picklists allow users to type in their own choice or pick an existing option, they may not be used with multiselect fields.							visible	false	boolean (1)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Polymorphic?	Foreign key	Through	Min. items	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to		created_by		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to		updated_by		0	1

Pricing Scheme

Class Private::Pricebook::PricingScheme

Scheme defining selling prices.

API URLs

API requests for this model should be directed to pricebook/pricing_schemes.api

The full metadata for this model can be obtained by an API client using the URL pricebook/pricing_schemes/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	Pricing scheme description							visible	nil	string (255)
from_date	Start	Date the Pricing scheme is valid from							visible	nil	date
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_default	Default	Is this the default Pricing Scheme							visible	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	Pricing scheme code							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
thru_date	Expiry	Date the Pricing scheme is valid until							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_price	Price	Pricing scheme price							visible	£0.00	currency (63,5)
unit_price_code	Unit price currency	Currency of the pricing scheme							visible	nil	string (3)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
product	Product	Product this scheme is for.	Private::Pricebook::Product	belongs_to	product_id	1
sales_tax_code	Sales tax code	Sales Tax Code that applies for the Pricing scheme	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Process Parameter

Class Private::Automation::ActionParameter

A list parameter values for a process that corresponds to the list of parameters defined for the associated Script. Note: The list of available parameters is automatically maintained by the process itself so the values can only be updated.

See the help on Process Parameters for more details.

API URLs

API requests for this model should be directed to automation/action_parameters.api

The full metadata for this model can be obtained by an API client using the URL automation/action_parameters/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
action_id	Action	Foreign key for action							invisible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	Describes the Process Parameter using a combination of the parameter name, parameter value and the name of the Action it relates to.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
parameter_description	Description	The description for the associated script parameter.							visible	nil	string (255)
parameter_name	Name	The name of the associated script parameter.							visible	nil	string (255)
parameter_value	Value	The value for the associated script parameter for the associated action.							visible	""	text (65535)
script_parameter_id	Script Parameter Id	The Id of the corresponding Script Parameter for the Script associated with the Process. Note: If the script resides in the library then the Id also relates to a library parameter.							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action	Action	The action that this parameter is for.	Private::Automation::Action	belongs_to	action_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Product

Class Private::Pricebook::Product

Goods or services purchased and/or sold

See the help on Products for more details.

API URLs

API requests for this model should be directed to pricebook/products.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL pricebook/products/metadata.api

Mandatory Fields

This model has mandatory fields:

Product Code (refcode)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The description of this Product.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_purchased	Available to be sold	A boolean set to true if the Product is available to be sold.							visible	nil	boolean (1)
is_supplied	Available to be bought	A boolean set to true if the Product is available to be bought.							visible	nil	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
nominal_cost	Default Cost	The default cost of this Product.							visible	£0.00	currency (63,5)
nominal_price	Default Price	The default price for this Product.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
product_category	Category	The category that this Product belongs to.							visible	nil	string (255)	Picklist: Product Categories Picklist id: 5 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
refcode	Product Code	The reference code for this Product.							visible	nil	string (255)
sales_tax_code_id	Default Tax Code	The default tax code for this Product.							invisible	nil	integer (4)	Picklist: Class: Sales Tax Codes (Private::Accounting::SalesTaxCode) Value field: id Display field: description Path: /picklist_data/Private_Accounting_SalesTaxCode/id/description.wbjson?find_method=pick_with_context Return fields: []
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_type	Unit	The type of units this Product is sold in.							visible	nil	string (255)	Picklist: Units Picklist id: 14 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: true Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
pricing_schemes	Pricing schemes	Pricing Schemes for this Product.	Private::Pricebook::PricingScheme	has_many	product_id	Infinity
sales_tax_code	Sales tax code	The default tax code applied when generating customer documents.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_schemes	Supply schemes	Supply Schemes for this Product.	Private::Pricebook::SupplyScheme	has_many	product_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Related Item

Class Private::Activity::ActivityLink

A relationship between an Activity and other objects

See the help on Related Items for more details.

API URLs

API requests for this model should be directed to activity/activity_links.api

The full metadata for this model can be obtained by an API client using the URL activity/activity_links/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
activity_id	Activity	Foreign key for activity							invisible	nil	integer (4)
activity_type	Activity type	Foreign type for activity							invisible	nil	string (255)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The activity link descriptor							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
resource_id	Resource	Foreign key for resource							invisible	nil	integer (4)
resource_type	Resource type	Foreign type for resource							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
status	Status	The Status of the Resource that the Activity is related to.							visible	""	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
activity	Activity	The Activity that is related to the Resource.	Private::Activity::Meeting Private::Activity::Task	belongs_to	activity_id	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
resource	Resource	The Resource that the Activity is related to.	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::PurchaseOrder Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Crm::Case Private::Crm::MarketingCampaign Private::Crm::Person Private::Crm::Organisation Private::Crm::PersonLeadParty Private::Crm::Opportunity Private::Crm::SalesLead Private::Email Private::EmailTemplate Private::Note Private::GoogleDocNote Private::ExternalLinkNote Private::Pricebook::Product Private::UploadFile	belongs_to	resource_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Related Item

Class Private::RelatedItem

Relation between two Objects

See the help on Related Items for more details.

API URLs

API requests for this model should be directed to related_items.api

The full metadata for this model can be obtained by an API client using the URL related_items/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	The related items descriptor							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
related_item_id	Related item	Foreign key for related_item							invisible	nil	integer (4)
related_item_type	Related item type	Foreign type for related_item							invisible	nil	string (255)
source_id	Source	Foreign key for source							invisible	nil	integer (4)
source_type	Source type	Foreign type for source							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
related_item	Target Record	The target Object that the relationship is to	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::PurchaseOrder Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Crm::Case Private::Crm::MarketingCampaign Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::PersonLeadParty Private::Crm::SalesLead Private::Email Private::EmailTemplate Private::ScheduledEmail Private::AbstractNote Private::Pricebook::Product Private::UploadFile	belongs_to	related_item_id	1
source	Source Record	The source Object that the relationship is from	Private::Activity::Meeting Private::Activity::Task Private::Accounting::CreditNote Private::Accounting::Invoice Private::Accounting::PurchaseOrder Private::Accounting::Quotation Private::Accounting::SalesOrder Private::Accounting::Contract Private::Crm::Case Private::Crm::MarketingCampaign Private::Crm::Opportunity Private::Crm::Organisation Private::Crm::Person Private::Crm::PersonLeadParty Private::Crm::SalesLead Private::Email Private::EmailTemplate Private::ScheduledEmail Private::AbstractNote Private::Pricebook::Product Private::UploadFile	belongs_to	source_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Report View

Class Private::Reporting::DataView

A list of items in your database based on a prescribed selection

See the help on Report Views for more details.

API URLs

API requests for this model should be directed to reporting/data_views.api

The full metadata for this model can be obtained by an API client using the URL reporting/data_views/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
description	Description	The Description of this Report View.							visible	""	text (65535)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
last_run_at	Last run at	When this Report View was last run.							visible	nil	datetime
last_run_by	Last run by	The id of the last User to run this Report View.							invisible	nil	integer (4)
last_run_by_user[login_name]	Last run by login	The login name of the last User to run this Report View.							visible	nil	string (255)
last_run_by_user[person_name]	Last run by name	The name of the last User to run this Report View.							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The Name of this Report View.							visible	""	string (255)
report_id	Report	Foreign key for report							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
last_run_by_user	Last run by	The last User to run this Report View.	Private::CachedUser	belongs_to	last_run_by	1
report	Report	The Report for this Report View.	Private::Reporting::Report	belongs_to	report_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Report

Class Private::Reporting::Report

A list of items in your database based on a prescribed selection

See the help on Reports for more details.

API URLs

API requests for this model should be directed to reporting/reports.api

The full metadata for this model can be obtained by an API client using the URL reporting/reports/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
category	Category	The Category of this Report.							visible	""	string (255)	Picklist: Report Categories Picklist id: 60 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
description	Description	The Description of this Report.							visible	""	text (65535)
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
last_run_at	Last run at	When a View within this Report was last run.							visible	nil	datetime
last_run_by	Last run by	The id of the last User to run a View within this Report.							invisible	nil	integer (4)
last_run_by_user[login_name]	Last run by login	The login name of the last User to run a View within this Report.							visible	nil	string (255)
last_run_by_user[person_name]	Last run by name	The name of the last User to run a View within this Report.							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The Name of this Report.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
last_run_by_user	Last run by	The last User to run a View within this Report.	Private::CachedUser	belongs_to	last_run_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Sales Lead Person

Class Private::Crm::PersonLeadParty

People attached to Sales Leads

See the help on Sales Lead People for more details.

API URLs

API requests for this model should be directed to crm/person_lead_parties.api

The full metadata for this model can be obtained by an API client using the URL crm/person_lead_parties/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
_link_or_create_employer	Link or create Employer by name	Sets the employer to an Organisation that matches by name, or creates the Organisation if it does not exist.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Sales Lead Person could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Sales Lead Person Queues (Private::Crm::PersonLeadPartyQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_PersonLeadParty/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
employer_link	Employer	A picklist of possible employers, set to the current employer.							visible	nil	integer (4)	Linked item: employer_link Title: Employer Linked classes: Organisations (Private::Crm::Organisation) Association: employer_link Value field: id Display field: name Path: /picklist_data/Private_Crm_PersonLeadParty/id/name.wbjson?_linked_item_name=employer_link Return fields: [ organisation_vat_number, website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
employer_name	Employer	The name of the current employer of this Person.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lead_source_type	Source	Where the information on this Party came from originally.							visible	nil	string (255)	Picklist: Lead Source Types Picklist id: 6 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
main_location[alternate_telephone]	Alternate Telephone	The alternate main telephone number.							visible	nil	string (255)
main_location[country]	Country	The main country.							visible	nil	string (255)	Picklist: Countries Picklist id: 3 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
main_location[county_province_state]	County/State	The main county or state.							visible	nil	string (255)
main_location[email]	Email	The main email address of this Person.							visible	nil	string (255)
main_location[fax]	Fax	The main fax number.							visible	nil	string (255)
main_location[mobile]	Mobile	The main mobile number for this Person.							visible	nil	string (255)
main_location[postcode]	Postcode/Zipcode	The main postcode or zipcode.							visible	nil	string (255)
main_location[street_address]	Street Address	The main street address.							visible	nil	string (255)
main_location[telephone]	Telephone	The main telephone number.							visible	nil	string (255)
main_location[town]	Town or City	The main town or city.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
main_location_id	Main location	Foreign key for main_location							invisible	nil	integer (4)
marketing_campaign[name]	Campaign	The name of the Marketing Campaign that this Party came from.							visible	nil	string (255)
name	Person name	The Person's name.							visible	nil	string (255)
no_email_soliciting	No email	A boolean set to true if the Person does not want to receive emails.							visible	false	boolean (1)
no_phone_soliciting	No sales calls	A boolean set to true if the Party does not want phone calls.							visible	false	boolean (1)
no_post_soliciting	No postal	A boolean set to true if the Party does not want to receive letters.							visible	false	boolean (1)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
party_notes	Notes	A notes field on the record itself.							visible	nil	text (16777215)
person_first_name	First name	The first name of this Person.							visible	nil	string (255)
person_job_role	Job role	The job role of the Person - a picklist.							visible	nil	string (255)	Picklist: Person Job Roles Picklist id: 1 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_job_title	Job title	The job title of the Person.							visible	nil	string (255)
person_last_name	Last name	The last name of this Person.							visible	nil	string (255)
person_middle_name	Middle name	The middle name of this Person.							visible	nil	string (255)
person_personal_title	Title	The Person's title.							visible	nil	string (255)	Picklist: Personal Titles Picklist id: 16 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_salutation	Salutation	A salutation that can be used to address this Person.							visible	nil	string (255)
person_suffix	Suffix	The suffix to the name of this Person.							visible	nil	string (255)
preferred_language	Preferred language	The language that this Person prefers to converse in.							visible	nil	string (255)	Picklist: Languages Picklist id: 29 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
queue_entry[queue][name]	Assigned to name	The name of the queue that this Sales Lead Person is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Sales Lead Person is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Sales Lead Person was assigned.							visible	nil	datetime
sales_lead[id]	Sales Lead id	The id of the Sales Lead of this Person.							visible	nil	integer (4)
special_requirements	Special requirements	Any special requirements that this Person may have.							visible	nil	string (255)	Picklist: Party Special Requirements Picklist id: 28 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)
website	Website	The address of the website of this Party.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	The Activities that are related to this Party.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Party.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Sales Lead Person could be assigned to.	Private::Crm::PersonLeadPartyQueue	has_one	assigned_to		1	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
employer	Employer (main)	The current employer of this Person.	Private::Crm::Organisation	has_one	abstract_person_id	employer_relationship	0	1
employer_link	Employer	A picklist of possible employers, set to the current employer.	Private::Crm::Organisation	integer	employer_link		1	1
employer_relationship	Employer relationship	The Party Relationship that links this Person to their employer.	Private::Crm::PartyRelationship	has_one	from_party_id		0	1
main_location	Main location	The main location, containing an address and various contact details.	Private::Crm::Location	belongs_to	main_location_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
queue	Assigned to	The Queue that this Sales Lead Person is assigned to.	Private::Crm::PersonLeadPartyQueue	has_one	person_lead_party_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Sales Lead Person to the Queue.	Private::Crm::PersonLeadPartyQueueEntry	has_one	person_lead_party_id		0	1
sales_lead	Sales Lead	The Sales Lead of this Person.	Private::Crm::SalesLead	has_one	person_lead_party_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Sales Lead Person Queue

Class Private::Crm::PersonLeadPartyQueue

A list of Sales Lead People assigned to a waiting list

API URLs

API requests for this model should be directed to crm/person_lead_party_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/person_lead_party_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	0	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
person_lead_parties	Person lead parties	The set of Sales Lead People on this queue.	Private::Crm::PersonLeadParty	has_many	person_lead_party_queue_id	queue_entries	Infinity
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::PersonLeadPartyQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Sales Lead Queue

Class Private::Crm::SalesLeadQueue

A list of Sales Leads assigned to a waiting list

API URLs

API requests for this model should be directed to crm/sales_lead_queues.api

The full metadata for this model can be obtained by an API client using the URL crm/sales_lead_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
queue_entries	Queue entries	The set of entries on this queue.	Private::Crm::SalesLeadQueueEntry	has_many	queue_id		Infinity
sales_leads	Sales leads	The set of Sales Leads on this queue.	Private::Crm::SalesLead	has_many	sales_lead_queue_id	queue_entries	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Sales Lead

Class Private::Crm::SalesLead

People or Organisations potentially interested in your goods or services

See the help on Sales Leads for more details.

API URLs

API requests for this model should be directed to crm/sales_leads.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL crm/sales_leads/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Lead person's name (person_lead_party[name])

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
assigned_to	Assigned to	A picklist of queues that this Sales Lead could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Sales Lead Queues (Private::Crm::SalesLeadQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Crm_SalesLead/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
last_contacted	Last contacted	When the Sales Lead was last contacted							visible	nil	date
lead_source_type	Source	The source of the Sales Lead							visible	nil	string (255)	Picklist: Lead Source Types Picklist id: 6 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
marketing_campaign[name]	Campaign	The name of the Marketing Campaign that the Sales Lead came from							visible	nil	string (255)
marketing_campaign_id	Campaign ID	The ID of the Marketing Campaign that discovered this Sales Lead.							invisible	nil	integer (4)	Picklist: Class: Marketing Campaigns (Private::Crm::MarketingCampaign) Value field: id Display field: name Path: /picklist_data/Private_Crm_MarketingCampaign/id/name.wbjson?find_method=pick_available Return fields: [ mailing_list[public_name] ]
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
name	Sales Lead name	A name for the Sales Lead.							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
org_lead_party[industry]	Industry	The industry vertical that the Organisation operates in							visible	nil	string (255)
org_lead_party[main_location][country]	Country	The country of the Organisation							visible	nil	string (255)	Picklist: Countries Picklist id: 3 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
org_lead_party[main_location][county_province_state]	County/State	The county or state of the Organisation							visible	nil	string (255)
org_lead_party[main_location][email]	Email	The Organisation's email address							visible	nil	string (255)
org_lead_party[main_location][fax]	Fax	The Organisation's fax number							visible	nil	string (255)
org_lead_party[main_location][mobile]	Mobile	The Organisation's mobile number							visible	nil	string (255)
org_lead_party[main_location][postcode]	Postcode/Zipcode	The postcode of the Organisation							visible	nil	string (255)
org_lead_party[main_location][street_address]	Street Address	The street address of the Organisations							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
org_lead_party[main_location][telephone]	Telephone	The Organisation's telephone number							visible	nil	string (255)
org_lead_party[main_location][town]	Town or City	The town of the Organisation							visible	nil	string (255)
org_lead_party[name]	Organisation	The name of the Organisation							visible	nil	string (255)
org_lead_party[no_email_soliciting]	No Email	A boolean set to true if the Party does not want to receive emails							visible	false	boolean (1)
org_lead_party[no_phone_soliciting]	No Sales Calls	A boolean set to true if the Party does not want phone calls							visible	false	boolean (1)
org_lead_party[no_post_soliciting]	No Postal	A boolean set to true if the Party does not want to receive letters							visible	false	boolean (1)
org_lead_party[organisation_annual_revenue]	Annual Revenue	The annual revenue of the Sales Lead Organisation							visible	£0.00	currency (63,5)
org_lead_party[organisation_category]	Organisation Category	The category of the Organisation							visible	nil	string (255)
org_lead_party[organisation_num_employees]	Number of Employees	The number of employees of the Sales Lead Organisation							visible	nil	integer (4)
org_lead_party[website]	Website	The Organisation's Website							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
org_lead_party_id	Org lead party	Foreign key for org_lead_party							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
person_lead_party[name]	Lead person's name	The Person's full name							visible	nil	string (255)
person_lead_party[person_first_name]	First name	The Person's first name							visible	nil	string (255)
person_lead_party[person_job_role]	Job role	The Person's job role							visible	nil	string (255)	Picklist: Person Job Roles Picklist id: 1 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_lead_party[person_job_title]	Job title	The Person's job title							visible	nil	string (255)
person_lead_party[person_last_name]	Last name	The Person's last name							visible	nil	string (255)
person_lead_party[person_middle_name]	Middle name	The Person's middle name							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
person_lead_party[person_personal_title]	Title	The Person's title							visible	nil	string (255)	Picklist: Personal Titles Picklist id: 16 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
person_lead_party[person_salutation]	Salutation	An appropriate greeting to the Person							visible	nil	string (255)
person_lead_party[person_suffix]	Suffix	The suffix to the Person's name							visible	nil	string (255)
person_lead_party_id	Person lead party	Foreign key for person_lead_party							invisible	nil	integer (4)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Sales Lead is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Sales Lead is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Sales Lead was assigned.							visible	nil	datetime
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_lead_rating_type	Rating	A picklist of Sales Lead ratings							visible	nil	string (255)	Picklist: Lead Rating Types Picklist id: 11 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
sales_lead_status_type	Status	A picklist of Sales Lead statuses							visible	nil	string (255)	Picklist: Sales Lead Statuses Picklist id: 15 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
activities	Activities	The Activities that are related to this Sales Lead.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Sales Lead.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Sales Lead could be assigned to.	Private::Crm::SalesLeadQueue	has_one	assigned_to		1	1
campaign_membership	Campaign Membership	The Sales Lead's membership to the Campaign	Private::Crm::CampaignMembership	has_many	party_or_lead_id		0	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
marketing_campaign	Campaign	The Campaign that discovered this Sales Lead.	Private::Crm::MarketingCampaign	belongs_to	marketing_campaign_id		0	1
org_lead_party	Lead organisation	The Organisation referred to by this Sales Lead	Private::Crm::OrganisationLeadParty	belongs_to	org_lead_party_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
person_lead_party	Lead person	The Person to contact regarding this Sales Lead.	Private::Crm::PersonLeadParty	belongs_to	person_lead_party_id		0	1
queue	Assigned to	The Queue that this Sales Lead is assigned to.	Private::Crm::SalesLeadQueue	has_one	sales_lead_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Sales Lead to the Queue.	Private::Crm::SalesLeadQueueEntry	has_one	sales_lead_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Sales Tax Code

Class Private::Accounting::SalesTaxCode

A Sales Tax Code for a Tax Regime

API URLs

API requests for this model should be directed to accounting/sales_tax_codes.api

The full metadata for this model can be obtained by an API client using the URL accounting/sales_tax_codes/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The sales tax code description							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
sales_tax_code	Sales tax code	The sales tax code							visible	nil	string (255)
tax_regime_id	Tax regime	Foreign key for tax_regime							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
sales_tax_values	Sales tax values	The values of this sales tax code	Private::Accounting::SalesTaxValue	has_many	sales_tax_code_id	Infinity
tax_regime	Tax regime	Tax Regime this tax code is applicable for.	Private::Accounting::TaxRegime	belongs_to	tax_regime_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Sales Tax Value

Class Private::Accounting::SalesTaxValue

A Sales Tax tax rate for a period under a Sales Tax Code for a Tax Regime

API URLs

API requests for this model should be directed to accounting/sales_tax_values.api

The full metadata for this model can be obtained by an API client using the URL accounting/sales_tax_values/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
rate_percent	Rate percent	The tax rate applied between these dates for this tax code							visible	nil	decimal (9,2)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
valid_from	From	The start date of this tax rate							visible	nil	date
valid_thru	Until	The end date of this tax rate							visible	nil	date

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
sales_tax_code	Sales tax code	The tax code that this value belongs to	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Scheduled Process

Class Private::Automation::ScheduledAction

A process which will run a Workbooks Script in the background according to a schedule

See the help on Scheduled Processes for more details.

API URLs

API requests for this model should be directed to automation/scheduled_actions.api

The full metadata for this model can be obtained by an API client using the URL automation/scheduled_actions/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)
Schedule to run (schedule_style)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the Scheduled Process.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
published_script	Published Script	A flag to indicate that the Script associated with Scheduled Process is located in the Script Library.							visible	false	boolean (1)
schedule_at_time_daily	Schedule Daily At	The time of the day that the schedule should run when scheduling the process to run Daily.							visible	Sat Jan 01 08:00:00 UTC 2000	time
schedule_at_time_monthly	Schedule Monthly At	The time of the day that the schedule should run when scheduling the process to run Monthly.							visible	Sat Jan 01 08:00:00 UTC 2000	time
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
schedule_day_friday	Schedule on Friday	A flag to indicate whether the schedule includes Fridays.							visible	true	boolean (1)
schedule_day_monday	Schedule on Monday	A flag to indicate whether the schedule includes Mondays.							visible	true	boolean (1)
schedule_day_saturday	Schedule on Saturday	A flag to indicate whether the schedule includes Saturdays.							visible	false	boolean (1)
schedule_day_sunday	Schedule on Sunday	A flag to indicate whether the schedule includes Sundays.							visible	false	boolean (1)
schedule_day_thursday	Schedule on Thursday	A flag to indicate whether the schedule includes Thursdays.							visible	true	boolean (1)
schedule_day_tuesday	Schedule on Tuesday	A flag to indicate whether the schedule includes Tuesdays.							visible	true	boolean (1)
schedule_day_wednesday	Schedule on Wednesday	A flag to indicate whether the schedule includes Wednesdays.							visible	true	boolean (1)
schedule_disable_after	Schedule Until	The last date that the Scheduled Process should keep scheduling itself until.							visible	nil	date
schedule_enabled	Schedule Enabled	A flag to enable/disable the scheduling of the Scheduled Process.							visible	true	boolean (1)
schedule_every_hours	Schedule Every Hours	The number of hours between each run when scheduling the process to run Hourly.							visible	1	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
schedule_every_minutes	Schedule Every Minutes	The number of minutes between each run when scheduling the process to run Frequently.							visible	15	integer (4)
schedule_hours_range_end	Schedule Hours End	The time of the day that the schedule should end when scheduling the process to run Hourly.							visible	Sat Jan 01 20:00:00 UTC 2000	time
schedule_hours_range_start	Schedule Hours Start	The time of the day that the schedule should start when scheduling the process to run Hourly.							visible	Sat Jan 01 08:00:00 UTC 2000	time
schedule_location_monthly	Schedule Monthly Day	Indicates whether the process should be scheduled to run on the first or last selected day of the week when scheduling the process to run Monthly.							visible	10	integer (4)	Picklist: Value field: id Display field: name Data: [ {name => 'first', id => 10}, {name => 'last', id => 20} ]
schedule_minutes_range_end	Schedule Minutes End	The time of the day that the schedule should end when scheduling the process to run Frequently.							visible	Sat Jan 01 20:00:00 UTC 2000	time
schedule_minutes_range_start	Schedule Minutes Start	The time of the day that the schedule should start when scheduling the process to run Frequently.							visible	Sat Jan 01 08:00:00 UTC 2000	time
schedule_next_recurs_not_before	Next Due	The date and time that the Scheduled Process is next due to run.							visible	nil	datetime
schedule_now	Schedule Now	A flag to tell the Scheduled Process to schedule itself to run as soon as possible.							visible	false	boolean (1)
schedule_style	Schedule to run	The frequency at which the Scheduled Process to schedule itself.							visible	20	integer (4)	Picklist: Value field: id Display field: name Data: [ {name => 'Frequently', id => 10}, {name => 'Hourly', id => 20}, {name => 'Daily', id => 30}, {name => 'Monthly', id => 40} ]
script_id	Script	Foreign key for script							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
script_name	Script Name	The name of the Script associated with Scheduled Process.							visible	""	string (255)
timeout	Maximum Time	The maximum time to allow this process to run for, in seconds.							visible	60	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action_parameters	Action Parameters	Parameters defined for this Web Process.	Private::Automation::ActionParameter	has_many	action_id	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
script	Script	The Script associated with Web Process.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Script Dependency

Class Private::Automation::ScriptDependency

Workbooks automation script required file

See the help on Script Dependencies for more details.

API URLs

API requests for this model should be directed to automation/script_dependencies.api

The full metadata for this model can be obtained by an API client using the URL automation/script_dependencies/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
descriptor	Descriptor	Describes the Script Dependency using a combination of the names of the two Scripts.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
requires_published_script	Requires published script	Flag to indicate that the required script is published (in the script library).							visible	false	boolean (1)
requires_script_id	Requires script	Foreign key for requires_script							invisible	nil	integer (4)
script_id	Script	Foreign key for script							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
requires_script	Requires Script	The required script defined by this dependency.	Private::Automation::Script	belongs_to	requires_script_id	1
script	Script	The script that is dependent on the required script.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Script Parameter

Class Private::Automation::ScriptParameter

Workbooks automation script parameter

See the help on Script Parameters for more details.

API URLs

API requests for this model should be directed to automation/script_parameters.api

The full metadata for this model can be obtained by an API client using the URL automation/script_parameters/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The description for the script parameter.							visible	nil	string (255)
descriptor	Descriptor	Describes the Script Parameter using a combination of the parameter name and the name of the Script it relates to.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the script parameter.							visible	nil	string (255)
script_id	Script	Foreign key for script							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
script	Script	The script that this parameter is for.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Script

Class Private::Automation::Script

Workbooks automation script

See the help on Scripts for more details.

API URLs

API requests for this model should be directed to automation/scripts.api

The full metadata for this model can be obtained by an API client using the URL automation/scripts/metadata.api

Mandatory Fields

This model has mandatory fields:

Maximum time (seconds) (default_timeout)
Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
code	Code	The actual code for the script that gets executed within the process engine.							visible	""	text (16777215)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
default_timeout	Maximum time (seconds)	The maximum time (in seconds) that the script is allowed to run before the process engine will kill it.							visible	60	integer (4)
description	Description	The long rich text description for the script.							visible	nil	text (65535)
external_access	Requires External Access?	A flag to indicate if the script requires external access.							visible	false	boolean (1)
id	Id	The id of this object.							hidden	nil	integer (4)
language	Language	The language that the script is written in - currently the process engine only supports php.							visible	"php"	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the script.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
summary	Summary	The short summary text for the script.							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
actions	Actions	Processes that execute this script.	Private::Automation::Action	has_many	script_id	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
script_dependencies	Script Dependencies	Other scripts that this script depends upon.	Private::Automation::ScriptDependency	has_many	script_id	Infinity
script_parameters	Script Parameters	Parameters defined for this script.	Private::Automation::ScriptParameter	has_many	script_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Searchable

Class Private::Searchable

Provides a means to search across a variety of objects finding the "best match" based on a search string

See the help on Searchables for more details.

API URLs

API requests for this model should be directed to searchables.api

The full metadata for this model can be obtained by an API client using the URL searchables/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
controller_for_searchable	Controller	The controller which can be used to access the found object							visible	""	string (255)
display_name	Display name	Plain text summary of the found object							visible	nil	string (255)
highlighted	Highlighted	Text from the found object with matched text wrapped in "wbStartSearchHighlight....wbEndSearchHighlight"							visible	""	string (255)
id	Id	The id of the searchable record, not the indexed object							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
model_icon	Icon	Icon name of the found object							visible	""	string (255)
model_type	Human type	Human name of the found object type							visible	""	string (255)
object_ref	Object reference	The unique reference of the found object							visible	nil	string (255)
soundex_code	Name Soundex	The soundex value for the display name							visible	""	string (255)
source_id	Source ID	The ID of the object which has been found. Note that _can_modify etc refer to the permissions on this object.							invisible	nil	integer (4)
source_type	Source Type	The full type name of the object which has been found							invisible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)

There are no related models.

Supplier Order Line Item

Class Private::Accounting::PurchaseOrderLineItem

Line Items belonging to Supplier Orders

See the help on Supplier Order Line Items for more details.

API URLs

API requests for this model should be directed to accounting/purchase_order_line_items.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/purchase_order_line_items/metadata.api

Mandatory Fields

This model has mandatory fields:

Unit cost (document currency) (document_currency_unit_cost)
Quantity (unit_quantity)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
delivery_date	Delivery date	The planned Delivery Date for this Line Item.							visible	nil	date
description	Line Description	A description of the product in this Line Item.							visible	nil	string (255)
discount_percent	Price Discount %	The percentage Discount on this Line Item.							visible	nil	decimal (9,6)
display_order	Display order	The order to display this Line Item in relative to the other Line Items in this Transaction document.							visible	0	integer (4)
document_currency	Document currency	The currency of the Transaction document that this Line Item belongs to.							visible	nil	string (255)
document_currency_gross_value	Gross (document currency)	The Gross value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The Net value of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The Sales Tax of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_tax_adjustment	Tax adjustment (document currency)	The Tax Adjustment of this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_unit_cost	Unit cost (document currency)	The Unit Cost of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_currency_unit_price_value	Unit price (document currency)	The Unit Price of the items in this Line Item in the Transaction document's currency.							visible	£0.00	currency (63,5)
document_header[object_ref]	Accounting Document	The reference of the Transaction that this Line Item belongs to.							visible	nil	string (255)
document_header_id	Document header	Foreign key for purchase_order_document							invisible	nil	integer (4)
end_date	End Date	The end date of the line item							visible	nil	date
home_currency	Home currency	The currency of the Own Organisation that this Line Item will be accounted in.							visible	nil	string (255)
home_currency_gross_value	Gross (home currency)	The Gross value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The Net value of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The Sales Tax of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The Tax Adjustment of this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_unit_cost	Unit cost (home currency)	The Unit Cost of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_unit_price_value	Unit price (home currency)	The Unit Price of the items in this Line Item in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
location_id	Location	Foreign key for location							invisible	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
pricing_scheme[name]	Pricing scheme	The name of the Pricing Scheme that this Line Item uses.							visible	nil	string (255)
pricing_scheme_id	Pricing scheme	Foreign key for pricing_scheme							invisible	nil	integer (4)
product[refcode]	Product	The reference of the Product that this Line Item refers to.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
product_id	Product	Foreign key for product							invisible	nil	integer (4)
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
sales_tax_code[sales_tax_code]	Tax code	The name of the Sales Tax code that this Line Item uses.							visible	nil	string (255)
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
start_date	Start Date	The start date of the line item							visible	nil	date
status	Status	The status of the line item							visible	""	string (255)	Picklist: Supplier Order Line Item Statuses Picklist id: 55 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: false Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
supply_scheme[name]	Supply scheme	The name of the Supply Scheme that this Line Item uses.							visible	nil	string (255)
supply_scheme_id	Supply scheme	Foreign key for supply_scheme							invisible	nil	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_quantity	Quantity	The number of items in this Line Item.							visible	nil	decimal (18,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
Time	time

Display position name	Display position value
Main	1

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
document_header	Accounting Document	The Transaction that this Line Item belongs to (DEPRECATED).	Private::Accounting::DocumentHeader	belongs_to	document_header_id	1
location	Location	The Location associated with this line item	Private::Crm::Location	belongs_to	location_id	1
pricing_scheme	Pricing scheme	The Pricing Scheme that this Line Item uses.	Private::Pricebook::PricingScheme	belongs_to	pricing_scheme_id	1
product	Product	The Product that this Line Item refers to.	Private::Pricebook::Product	belongs_to	product_id	1
purchase_order_document	Supplier Order	The Supplier Order that this Line Item belongs to.	Private::Accounting::PurchaseOrder	belongs_to	document_header_id	1
sales_tax_code	Sales tax code	The Sales Tax code that this Line Item uses.	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supply_scheme	Supply scheme	The Supply Scheme that this Line Item uses.	Private::Pricebook::SupplyScheme	belongs_to	supply_scheme_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Supplier Order Queue

Class Private::Accounting::PurchaseOrderQueue

A list of Supplier Orders assigned to a waiting list

API URLs

API requests for this model should be directed to accounting/purchase_order_queues.api

The full metadata for this model can be obtained by an API client using the URL accounting/purchase_order_queues/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	A description of this Queue.							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of this Queue.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
queue_type	Queue type	The type of this Queue: one of 'user', 'queue' or 'unassigned'.							visible	"queue"	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		1
purchase_orders	Purchase orders	The set of Supplier Orders on this queue.	Private::Accounting::PurchaseOrder	has_many	purchase_order_queue_id	queue_entries	Infinity
queue_entries	Queue entries	The set of entries on this queue.	Private::Accounting::PurchaseOrderQueueEntry	has_many	queue_id		Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		1

Supplier Order

Class Private::Accounting::PurchaseOrder

Orders to your suppliers for their goods or services

See the help on Supplier Orders for more details.

API URLs

API requests for this model should be directed to accounting/purchase_orders.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL accounting/purchase_orders/metadata.api

Mandatory Fields

This model has mandatory fields:

Assigned to (assigned_to)
Supplier Order Name (description)
Document Currency (document_currency)
Supplier Order Date (document_date)
Status (status)
Tax point date (tax_point_date)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
accounting_period[name]	Period name	The name of the Accounting Period that this Transaction occurred in.							visible	nil	string (255)
accounting_period_id	Accounting period ID	The ID of the Accounting Period that this Transaction occurred in.							invisible	nil	integer (4)	Picklist: Class: Accounting Periods (Private::Accounting::AccountingPeriod) Value field: id Display field: full_name Path: /picklist_data/Private_Accounting_AccountingPeriod/id/full_name.wbjson Return fields: []
address	Address	The address to send this Transaction document to.							visible	nil	string (255)
assigned_to	Assigned to	A picklist of queues that this Supplier Order could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Supplier Order Queues (Private::Accounting::PurchaseOrderQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Accounting_PurchaseOrder/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
campaign[name]	Campaign	The name of the Marketing Campaign that the Opportunity that this Transaction is related to came from.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
campaign_id	Campaign	Foreign key for campaign							invisible	nil	integer (4)
comment	Comments	Comments on this Transaction.							visible	nil	text (65535)
create_from_id	Create from	The id of an existing document to copy values from during creation. NOTE: this will fail for required custom fields with a blank default value.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_from_document_id	Created from document	Foreign key for created_from_document							invisible	nil	integer (4)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
description	Supplier Order Name	The description of this Supplier Order.							visible	nil	string (255)
descriptor	Object reference and description	Combined object reference and description of the transaction document.							visible	nil	string (255)
discount_applied_before_totalling	Line Item Discount Applied Before Totals	Whether the line item calculation has had the discount(s) applied to the unit price before totals are calculated							visible	true	boolean (1)
document_currency	Document Currency	The currency of this Transaction.							visible	nil	string (255)
document_currency_balance_value	Balance (document currency)	The balance of this Transaction.							visible	£0.00	currency (63,5)
document_currency_cost	Cost (document currency)	The cost of this Transaction.							visible	£0.00	currency (63,5)
document_currency_gross_value	Gross (document currency)	The gross value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_discount	Net discount (document currency)	The net discount of this Transaction.							visible	£0.00	currency (63,5)
document_currency_net_value	Net (document currency)	The net value of this Transaction.							visible	£0.00	currency (63,5)
document_currency_sales_tax_value	Sales tax (document currency)	The sales tax value of this Transaction.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
document_currency_tax_adjustment	Tax adjustment (document currency)	The sales tax adjustment of this Transaction.							visible	£0.00	currency (63,5)
document_date	Supplier Order Date	The official date for this Supplier Order.							visible	nil	date
document_type[description]	Document Type Description	The description of this Type of Transaction.							visible	nil	string (255)
document_type_id	Document type	Foreign key for document_type							invisible	nil	integer (4)
exchange_rate	Exchange rate	The exchange rate between the home and document values for this Transaction.							visible	nil	decimal (18,6)
fao	F.A.O.	Who this Transaction should be addressed to (For the Attention Of).							visible	""	string (255)
home_currency	Home currency	The Own Organisation's currency for this Transaction.							visible	nil	string (255)
home_currency_balance_value	Balance (home currency)	The balance of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_cost	Cost (home currency)	The cost of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_gross_value	Gross (home currency)	The gross value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
home_currency_net_discount	Net discount (home currency)	The net discount of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_net_value	Net (home currency)	The net value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_sales_tax_value	Sales tax (home currency)	The sales tax value of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
home_currency_tax_adjustment	Tax adjustment (home currency)	The sales tax adjustment of this Transaction in the Own Organisation's currency.							visible	£0.00	currency (63,5)
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_synchronised	Supplier Order Synchronised	A boolean set to true if this supplier order has been synchronised to a third party service.							visible	nil	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
opportunity[name]	Opportunity	The name of the Opportunity that this Transaction is related to.							visible	nil	string (255)
opportunity_id	Opportunity ID	The ID of the Opportunity that this Transaction is related to.							invisible	nil	integer (4)	Linked item: opportunity_linked_item Title: Opportunity Linked classes: Opportunities (Private::Crm::Opportunity) Association: opportunity Value field: id Display field: description Path: /picklist_data/Private_Accounting_PurchaseOrder/id/description.wbjson?_linked_item_name=opportunity_id Return fields: []
own_organisation[name]	Own Organisation	The name of the Own Organisation that this Transaction belongs to.							visible	nil	string (255)
own_organisation_id	Own organisation	Foreign key for own_organisation							invisible	nil	integer (4)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
party[name]	Supplier	The name of the Supplier for this Transaction.							visible	nil	string (255)
party_id	Supplier ID	The ID of the Supplier Organisation or Person for this Transaction.							invisible	nil	integer (4)	Linked item: plain_party_linked_item Title: Supplier Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty), Organisations (Private::Crm::Organisation) Association: party Value field: id Display field: name Path: /picklist_data/Private_Accounting_PurchaseOrder/id/name.wbjson?_linked_item_name=party_id Return fields: [ website, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
party_refcode	Supplier Reference	The Supplier's reference.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
payment_due_date	Payment due date	The date that payment is due for this Transaction.							visible	nil	date
queue_entry[queue][name]	Assigned to name	The name of the queue that this Supplier Order is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Supplier Order is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Supplier Order was assigned.							visible	nil	datetime
status	Status	The status of this Transaction.							visible	nil	string (255)
tax_point_date	Tax point date	The date that sales tax will be calculated for this Transaction.							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
vat_number	Supplier VAT Number	The VAT number of the Supplier of this Transaction.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
accounting_period	Accounting period	The Accounting Period that this Transaction occurred in.	Private::Accounting::AccountingPeriod	belongs_to	accounting_period_id		0	1
activities	Activities	The set of Activities attached to this Transaction.	Private::Activity::Activity	has_many	private_db_id	activity_links	0	Infinity
activity_links	Activity links	A link table to the set of Activities for this Transaction.	Private::Activity::ActivityLink	has_many	resource_id		0	Infinity
assigned_to	Assigned to	A picklist of queues that this Supplier Order could be assigned to.	Private::Accounting::PurchaseOrderQueue	has_one	assigned_to		1	1
campaign	Campaign	The Marketing Campaign that the Opportunity that this Transaction is related to came from.	Private::Crm::MarketingCampaign	belongs_to	campaign_id		0	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
created_from_document	Created from Document	The transaction document that this transaction document was created from	Private::Accounting::DocumentHeader	belongs_to	created_from_document_id		0	1
document_header_contacts	Related Roles	People and Organisations with roles related to this Document	Private::Accounting::DocumentHeaderContact	has_many	document_header_id		0	Infinity
document_header_relationships	Transaction Document Relationships	Transaction document relationships to this record	Private::Accounting::DocumentHeaderRelationship	has_many	document_header_id		0	Infinity
document_type	Document Type	The Transaction Type of this Transaction.	Private::Accounting::DocumentType	belongs_to	document_type_id		0	1
notes	Notes	The set of Notes attached to this Transaction.	Private::AbstractNote	has_many	resource_id		0	Infinity
opportunity	Opportunity	The Opportunity that this Transaction is related to.	Private::Crm::Opportunity	belongs_to	opportunity_id		0	1
order_line_items	Line items	The set of line items in this Supplier Order.	Private::Accounting::PurchaseOrderLineItem	has_many	document_header_id		0	Infinity
own_organisation	Own Organisation	The Own Organisation that this Transaction belongs to.	Private::Crm::Organisation	belongs_to	own_organisation_id		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
party	Supplier	The Supplier for this Transaction.	Private::Crm::Party	belongs_to	party_id		0	1
party_organisation	Supplier (organisation)	The Supplier Organisation for this Transaction.	Private::Crm::Organisation	belongs_to	party_id		0	1
party_person	Supplier (person)	The Supplier Person for this Transaction.	Private::Crm::Person	belongs_to	party_id		0	1
queue	Assigned to	The Queue that this Supplier Order is assigned to.	Private::Accounting::PurchaseOrderQueue	has_one	purchase_order_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Supplier Order to the Queue.	Private::Accounting::PurchaseOrderQueueEntry	has_one	purchase_order_id		0	1
related_contracts	Related Contracts	Contracts related to this record	Private::Accounting::Contract	has_many	document_header_id	document_header_relationships	0	Infinity
related_credit_notes	Related Credit Notes	Credit Notes related to this record	Private::Accounting::CreditNote	has_many	document_header_id	document_header_relationships	0	Infinity
related_document_headers	Related Transaction Documents	Transaction documents related to this record	Private::Accounting::DocumentHeader	has_many	document_header_id	document_header_relationships	0	Infinity
related_invoices	Related Invoices	Invoices related to this record	Private::Accounting::Invoice	has_many	document_header_id	document_header_relationships	0	Infinity
related_opportunities	Related Opportunities	Opportunities related to this record	Private::Crm::Opportunity	has_many	document_header_id	document_header_relationships	0	Infinity
related_quotations	Related Quotations	Quotations related to this record	Private::Accounting::Quotation	has_many	document_header_id	document_header_relationships	0	Infinity
related_sales_orders	Related Sales Orders	Sales Orders related to this record	Private::Accounting::SalesOrder	has_many	document_header_id	document_header_relationships	0	Infinity
related_supplier_orders	Related Supplier Orders	Supplier Orders related to this record	Private::Accounting::PurchaseOrder	has_many	document_header_id	document_header_relationships	0	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Supply Scheme

Class Private::Pricebook::SupplyScheme

Scheme defining supplier and prices

API URLs

API requests for this model should be directed to pricebook/supply_schemes.api

The full metadata for this model can be obtained by an API client using the URL pricebook/supply_schemes/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	Description of this Supply Scheme							visible	nil	string (255)
from_date	Start	Date this Supply Scheme is valid from							visible	nil	date
id	Id	The id of this object.							hidden	nil	integer (4)
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_default	Is default	Indicates this is the default Supply Scheme							visible	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	Code for the Supply Scheme							visible	nil	string (255)
product_id	Product	Foreign key for product							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
sales_tax_code_id	Sales tax code	Foreign key for sales_tax_code							invisible	nil	integer (4)
supplier_id	Supplier	Foreign key for supplier							invisible	nil	integer (4)
suppliers_refcode	Supplier's Ref Code	Supplier's refcode for the product							visible	nil	string (255)
thru_date	Expiry	Date this Supply Scheme is valid until							visible	nil	date
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
unit_price	Cost	Unit Cost of this Supply Scheme							visible	£0.00	currency (63,5)
unit_price_code	Unit price code	Currency code for the cost of this Supply Scheme							visible	nil	string (3)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
product	Product	The product that this Supply Scheme is for	Private::Pricebook::Product	belongs_to	product_id	1
sales_tax_code	Sales tax code	Sales Tax Code for this Supply Scheme	Private::Accounting::SalesTaxCode	belongs_to	sales_tax_code_id	1
supplier	Supplier	Supplier who supplies products for this Supply Scheme	Private::Crm::Party	belongs_to	supplier_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Task

Class Private::Activity::Task

Planned or historic tasks

See the help on Tasks for more details.

API URLs

API requests for this model should be directed to activity/tasks.api

The full metadata for this model including Custom Fields can be obtained by an API client using the URL activity/tasks/metadata.api

Mandatory Fields

This model has mandatory fields:

Priority (activity_priority)
Status (activity_status)
Type (activity_type)
Assigned to (assigned_to)
Subject (name)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
activity_priority	Priority	The priority of the activity.							visible	"Medium"	string (255)	Picklist: Activity Priorities Picklist id: 21 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
activity_status	Status	The status of the activity.							visible	"New"	string (255)	Picklist: Activity Statuses Picklist id: 17 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
activity_type	Type	The type of the activity. NOTE: "Meeting" is not a valid value for a Task.							visible	"To-do"	string (255)	Picklist: Activity Types Picklist id: 12 Class: Picklist Entries (Private::PicklistEntry) Value field: value Display field: value Unrestricted?: true Auto-create?: false Path: /picklist_data/Private_PicklistEntry/value/value.wbjson Return fields: []
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.							visible	nil	has_one	Linked item: assigned_to Title: Assigned to Linked classes: Activity Queues (Private::Activity::ActivityQueue) Association: assigned_to Value field: id Display field: augmented_name Path: /picklist_data/Private_Activity_Task/id/augmented_name.wbjson?_linked_item_name=assigned_to Return fields: [ queue_type ]
completed_date	Completed Date	The date that the activity was completed.							visible	nil	date
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	The details of the activity.							visible	""	text (16777215)
descriptor	Subject and type	Combined Subject and Type of the activity.							visible	nil	string (255)
due_date	Due Date	The date that the activity is due to be completed by.							visible	nil	date
id	Id	The id of this object.							hidden	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
imported	Imported	Flag set to true if this object was imported.							hidden	false	boolean (1)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Subject	Subject of the activity.							visible	nil	string (255)
object_ref	Object Reference	The Reference for this object.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
primary_contact[employer_name]	Primary contact employer name	The name of the employer for the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][alternate_email]	Primary contact alternate email address	The alternate email address of the primary contact of the activity.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
primary_contact[main_location][alternate_telephone]	Primary contact alternate phone number	The alternate telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][email]	Primary contact email address	The email address of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][mobile]	Primary contact mobile number	The mobile number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[main_location][telephone]	Primary contact phone number	The telephone number of the primary contact of the activity.							visible	nil	string (255)
primary_contact[name]	Primary contact	The name of the primary contact of the activity.							visible	nil	string (255)
primary_contact_id	Primary contact ID	The ID of the primary contact Person or Sales lead.							invisible	nil	integer (4)	Linked item: primary_contact_item_linked_item Title: Primary contact Linked classes: People (Private::Crm::Person), Sales Lead People (Private::Crm::PersonLeadParty) Association: primary_contact Value field: id Display field: name Path: /picklist_data/Private_Activity_Task/id/name.wbjson?_linked_item_name=primary_contact_id Return fields: [ employer_name, website, type, main_location[mobile], main_location[email], main_location[street_address], main_location[town], main_location[county_province_state], main_location[postcode], main_location[country], main_location[telephone], main_location[fax] ]
primary_contact_type	Primary contact type	Foreign type for primary_contact							invisible	nil	string (255)
queue_entry[queue][name]	Assigned to name	The name of the queue that this Activity is assigned to.							visible	nil	string (255)
queue_entry[queue_id]	Assigned to id	The id of the queue that this Activity is assigned to.							visible	nil	integer (4)
queue_entry[updated_at]	Assigned at	The date and time when this Activity was assigned.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
record_state	Record state	The state of this record - open or closed.							visible	"open"	string (255)
reminder_datetime	Reminder time	The date and time of the reminder for the current user of the activity.							visible	Thu, 08 Jan 2015 10:00:00 GMT +00:00	datetime
reminder_enabled	Reminder	Boolean set to true if there is a reminder for the current user this activity.							visible	false	boolean (1)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
watched	Watched	A flag, set to true if the user is watching this object.							visible	false	boolean (1)

Custom Fields

This class supports custom fields with the following data types and display positions when used as the 'resource type' of a Custom Field.

Data type name	Data type value
Checkbox	boolean
Currency	currency
Date	date
Date & time	datetime
Decimal number	decimal
Email Address	email_link
IFrame	iframe
Integer number	integer
URL	linkable
Multi-line text	multiline
Percentage	percentage
Phone Number	phone_link
Picklist	picklist
Text	string
MultiSelect	tagarray
Rich Text	text
Time	time

Display position name	Display position value
Main	1
Additional	2

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Through	Min. items	Max. items
assigned_to	Assigned to	A picklist of queues that this Activity could be assigned to.	Private::Activity::ActivityQueue	has_one	assigned_to		1	1
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by		0	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id		0	1
primary_contact	Primary contact	The primary contact of the activity.	Private::Crm::Person Private::Crm::PersonLeadParty	belongs_to	primary_contact_id		0	1
queue	Assigned to	The Queue that this Activity is assigned to.	Private::Activity::ActivityQueue	has_one	activity_id	queue_entry	0	1
queue_entry	Queue entry	The Queue Entry that links this Activity to the Queue.	Private::Activity::ActivityQueueEntry	has_one	activity_id		0	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by		0	1

Tax Regime

Class Private::Accounting::TaxRegime

A Tax Regime

API URLs

API requests for this model should be directed to accounting/tax_regimes.api

The full metadata for this model can be obtained by an API client using the URL accounting/tax_regimes/metadata.api

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
description	Description	Verbose name of the Tax Regime							visible	nil	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	Code of the Tax Regime							visible	nil	string (255)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
sales_tax_codes	Sales tax codes	Sales Tax Codes applicable for this regime	Private::Accounting::SalesTaxCode	has_many	tax_regime_id	Infinity
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

User

Class Private::User

Users defined in your Account

See the help on Users for more details.

API URLs

API requests for this model should be directed to admin/users.api

The full metadata for this model can be obtained by an API client using the URL admin/users/metadata.api

NOTE: This model is read-only (none of the records can be updated via the API), or you do not have permission to update records in this model.

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
consecutive_failed_logins	Consecutive failed logins	The number of recent consecutive failed login attempts.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	"Workbooks"	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
date_time_locale	Date time locale	The locale that the user prefers dates and times to be displayed with.							visible	"en-gb"	string (255)
default_own_organisation[name]	Default Own Organisation	The Own Organisation that this user will use by default when creating transaction documents.							visible	nil	string (255)
granted_access	Granted access	Set to true if the user has access to this database.							visible	false	boolean (1)
id	Id	The id of this object.							hidden	nil	integer (4)
is_deleted	Is deleted	Boolean specifying whether this object has been deleted.							visible	false	boolean (1)
is_enabled	Is enabled	True if the user's login is enabled.							visible	true	boolean (1)
last_successful_login	Last successful login	The date and time when the user last logged in successfully.							visible	nil	datetime
last_successful_login_ip	Last successful login ip	The IP address that the user last logged in successfully from.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
last_unsuccessful_login	Last unsuccessful login	The date and time when the user last failed to login.							visible	nil	datetime
last_unsuccessful_login_ip	Last unsuccessful login ip	The IP address that the user last failed to login from.							visible	nil	string (255)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
login_name	Login	The email address that the user logs in to Workbooks with.							visible	nil	string (255)
login_prohibited_until	Login prohibited until	If set, the date and time that the user is prohibited from logging in until.							visible	nil	datetime
long_date_format	Long date format	The user's preferred format for dates in long form.							visible	"%o %B %Y"	string (255)
long_datetime_format	Long datetime format	The user's preferred format for dates and times in long form.							visible	"%o %B %Y %H:%M:%S %Z"	string (255)
long_time_format	Long time format	The user's preferred format for times in long form.							visible	"%H:%M"	string (255)
password_change_on_next_login	Password change on next login	True if the user must change their password at the next login.							visible	true	boolean (1)
password_last_changed	Password last changed	The date and time when the user last changed their password.							visible	nil	datetime
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
person_name	User name	The name of the user.							visible	nil	string (255)
short_date_format	Short date format	The user's preferred format for dates in short form.							visible	"%d/%m/%Y"	string (255)
short_datetime_format	Short datetime format	The user's preferred format for dates and times in short form.							visible	"%d/%m/%Y %H:%M:%S"	string (255)
short_time_format	Short time format	The user's preferred format for times in short form.							visible	"%H:%M"	string (255)
third_party_identity_providers	Third party identity providers	A list of third-party identity providers associated with the user.							visible	""	string (255)
timezone	Timezone	The user's preferred timezone.							visible	nil	string (255)
two_factor_only	Two factor only	If set to true, the user can only login with two-factor authentication.							visible	false	boolean (1)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)

Related models

Association name	Label	Description	Target Models	Type	Polymorphic?	Foreign key	Through	Min. items	Max. items
created_by_user	Created by	The creator of this object.	Global::UnrestrictedUser	belongs_to		created_by		0	1
updated_by_user	Updated by	The last updater of this object.	Global::UnrestrictedUser	belongs_to		updated_by		0	1

Web Process

Class Private::Automation::WebAction

A process invoked to create a Web page

See the help on Web Processes for more details.

API URLs

API requests for this model should be directed to automation/web_actions.api

The full metadata for this model can be obtained by an API client using the URL automation/web_actions/metadata.api

Mandatory Fields

This model has mandatory fields:

Name (name)
Identifier (web_identifier)

Fields

Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
_can_chaccess	_can_chaccess	Boolean specifying whether you can change the permissions on this object.							invisible	true	boolean (1)
_can_chown	_can_chown	Boolean specifying whether you can change the owner of this object.							invisible	true	boolean (1)
_can_delete	_can_delete	Boolean specifying whether you can delete this object.							invisible	true	boolean (1)
_can_modify	_can_modify	Boolean specifying whether you can modify this object.							invisible	true	boolean (1)
_can_read	_can_read	Boolean specifying whether you can read this object.							invisible	true	boolean (1)
authenticated_run_as	Run as (authenticated)	The Id of the User to run the authenticated Web Process as, this can be set to 0 to configure the process to run as the current User.							visible	nil	integer (4)
created_at	Created at	When this object was created.							visible	nil	datetime
created_by	Created by user id	The id of the creator of this object.							invisible	nil	integer (4)
created_by_user[login_name]	Created by login	The login name of the User that created this object.							visible	nil	string (255)
created_by_user[person_name]	Created by name	The name of the User that created this object.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
created_through	Created through	A keyword describing the creating application of this record.							hidden	nil	string (255)
created_through_reference	External Reference	A value defined by the creating application - normally a reference to an external equivalent record that is the source of this record.							hidden	""	string (255)
id	Id	The id of this object.							hidden	nil	integer (4)
lock_version	Lock version	Modification count - incremented each time this object is changed. You cannot modify this object without submitting a matching value for lock_version.							invisible	0	integer (4)
name	Name	The name of the Web Process.							visible	nil	string (255)
owner[login_name]	Owner login	The login name of the User that owns this object.							visible	nil	string (255)
owner[person_name]	Owner name	The name of the User that owns this object.							visible	nil	string (255)
owner_id	Owner user id	The id of the owner of this object.							invisible	nil	integer (4)
published_script	Published Script	A flag to indicate that the Script associated with Web Process is located in the Script Library.							visible	false	boolean (1)
script_id	Script	Foreign key for script							invisible	nil	integer (4)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
script_name	Script Name	The name of the Script associated with Web Process.							visible	""	string (255)
timeout	Maximum Time	The maximum time to allow this process to run for, in seconds.							visible	60	integer (4)
type	STI type	Type column that specifies the class of each row.							invisible	nil	string (255)
updated_at	Updated at	When this object was last updated.							visible	nil	datetime
updated_by	Updated by user id	The id of the last updater of this object.							invisible	nil	integer (4)
updated_by_user[login_name]	Updated by login	The login name of the User that updated this object.							visible	nil	string (255)
updated_by_user[person_name]	Updated by name	The name of the User that last updated this object.							visible	nil	string (255)
web_anonymous	Anonymous Access?	Flag to grant anonymous access to the Web Process enabling the process to be invoked from anywhere on the Internet, whether or not they are logged in.							visible	false	boolean (1)
web_anonymous_run_as	Run as (anonymous)	The Id of the User to run the anonymous Web Process as.							visible	nil	integer (4)
web_identifier	Identifier	The unique identifier of the Web Process, this value is appended to the end of the URL used to access this process.							visible	nil	string (255)
Field name	Label	Description	Null?	Filter?	Sort?	Create?	Update?	Required?	Visibility	Default value	Type (size)	Additional information
web_url	URL	The full URL used to access this process.							visible	""	string (255)

Related models

Association name	Label	Description	Target Models	Type	Foreign key	Max. items
action_parameters	Action Parameters	Parameters defined for this Web Process.	Private::Automation::ActionParameter	has_many	action_id	Infinity
created_by_user	Created by	The creator of this object.	Private::CachedUser	belongs_to	created_by	1
owner	Owner	The owner of this object.	Private::CachedUser	belongs_to	owner_id	1
script	Script	The Script associated with Web Process.	Private::Automation::Script	belongs_to	script_id	1
updated_by_user	Updated by	The last updater of this object.	Private::CachedUser	belongs_to	updated_by	1

Workbooks API Reference

Table of contents

Class Private::Accounting::AccountingPeriod

API URLs

Fields

Related models

Class Private::Activity::Activity

API URLs

Mandatory Fields

Fields

Related models

Class Private::Activity::ActivityAttendee

API URLs

Fields

Related models

Class Private::Activity::ActivityQueue

API URLs

Mandatory Fields

Fields

Related models

Class Private::Automation::ApiData

API URLs

Mandatory Fields

Fields

Related models

Class Private::ResourceUploadFile

API URLs

Fields

Related models

Class Private::Crm::CampaignMembershipStatus

API URLs

Mandatory Fields

Fields

Related models

Class Private::Crm::CampaignMembership

API URLs

Mandatory Fields

Fields

Related models

Class Private::Crm::CaseQueue

API URLs

Mandatory Fields

Fields

Related models

Class Private::Crm::Case

API URLs

Mandatory Fields

Fields

Custom Fields

Related models

Class Private::CustomField

API URLs

Mandatory Fields

Fields

Related models

Class Private::Accounting::ContractLineItem

API URLs

Mandatory Fields

Fields

Custom Fields

Related models

Class Private::Accounting::ContractQueue

API URLs

Mandatory Fields

Fields

Related models

Class Private::Accounting::Contract

API URLs

Mandatory Fields

Fields

Custom Fields

Related models

Class Private::Accounting::CreditNoteLineItem

API URLs

Mandatory Fields

Fields

Custom Fields

Related models

Class Private::Accounting::CreditNoteQueue

API URLs