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.

Table of contents

 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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
accounting_year Accounting year Accounting Year Private::Accounting::AccountingYear belongs_to
 
accounting_year_id 0 1
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

 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
activity Activity The associated Activity for this Attendee. Private::Activity::Activity belongs_to
 
activity_id 0 1
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
related_party Related Contact The Person or Lead related to the Attendee. Private::Crm::Person
Private::Crm::PersonLeadParty
belongs_to
 
related_party_id 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
activities Activities The set of Activities on this queue. Private::Activity::Activity has_many
 
activity_queue_id queue_entries 0 Infinity
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
queue_entries Queue entries The set of entries on this queue. Private::Activity::ActivityQueueEntry has_many
 
queue_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
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
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 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 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 1
upload_file Upload file The file attached to this resource. Private::UploadFile belongs_to
 
upload_file_id 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
marketing_campaign Campaign The Campaign that this Status is related to. Private::Crm::MarketingCampaign belongs_to
 
marketing_campaign_id 0 1
members Members The members of this Campaign with this Status. Private::Crm::CampaignMembership has_many
 
campaign_membership_status_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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.

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.

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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
lead Lead The sales lead whose Campaign Membership Status this is Private::Crm::SalesLead belongs_to
 
party_or_lead_id 0 1
marketing_campaign Campaign The Campaign that this campaign member is a member of Private::Crm::MarketingCampaign belongs_to
 
marketing_campaign_id 0 1
member_status Member Status The status of this member within the Campaign Private::Crm::CampaignMembershipStatus belongs_to
 
campaign_membership_status_id 0 1
organisation Organisation The organisation whose Campaign Membership Status this is Private::Crm::Organisation belongs_to
 
party_or_lead_id 0 1
person Person The person whose Campaign Membership Status this is Private::Crm::Person belongs_to
 
party_or_lead_id 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
cases Cases The set of Cases on this queue. Private::Crm::Case has_many
 
case_queue_id queue_entries 0 Infinity
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
queue_entries Queue entries The set of entries on this queue. Private::Crm::CaseQueueEntry has_many
 
queue_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Checkboxboolean
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
IFrameiframe
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
MultiSelecttagarray
Rich Texttext
Timetime

Display position nameDisplay position value
Main1
Additional2

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
Timetime

Display position nameDisplay position value
Main1

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
contract_document Customer Contract The Customer Contract that this Line Item belongs to. Private::Accounting::Contract belongs_to
 
document_header_id 0 1
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
document_header Accounting Document The Transaction that this Line Item belongs to (DEPRECATED). Private::Accounting::DocumentHeader belongs_to
 
document_header_id 0 1
location Location The Location associated with this line item Private::Crm::Location belongs_to
 
location_id 0 1
pricing_scheme Pricing scheme The Pricing Scheme that this Line Item uses. Private::Pricebook::PricingScheme belongs_to
 
pricing_scheme_id 0 1
product Product The Product that this Line Item refers to. Private::Pricebook::Product belongs_to
 
product_id 0 1
supply_scheme Supply scheme The Supply Scheme that this Line Item uses. Private::Pricebook::SupplyScheme belongs_to
 
supply_scheme_id 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
contracts Contracts The set of Customer Contracts on this queue. Private::Accounting::Contract has_many
 
contract_queue_id queue_entries 0 Infinity
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
queue_entries Queue entries The set of entries on this queue. Private::Accounting::ContractQueueEntry has_many
 
queue_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Checkboxboolean
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
IFrameiframe
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
MultiSelecttagarray
Rich Texttext
Timetime

Display position nameDisplay position value
Main1
Additional2

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
Timetime

Display position nameDisplay position value
Main1

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 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 0 1
document_header Accounting Document The Transaction that this Line Item belongs to (DEPRECATED). Private::Accounting::DocumentHeader belongs_to
 
document_header_id 0 1
location Location The Location associated with this line item Private::Crm::Location belongs_to
 
location_id 0 1
pricing_scheme Pricing scheme The Pricing Scheme that this Line Item uses. Private::Pricebook::PricingScheme belongs_to
 
pricing_scheme_id 0 1
product Product The Product that this Line Item refers to. Private::Pricebook::Product belongs_to
 
product_id 0 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 0 1
supply_scheme Supply scheme The Supply Scheme that this Line Item uses. Private::Pricebook::SupplyScheme belongs_to
 
supply_scheme_id 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 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 0 Infinity
owner Owner The owner of this object. Private::CachedUser belongs_to
 
owner_id 0 1
queue_entries Queue entries The set of entries on this queue. Private::Accounting::CreditNoteQueueEntry has_many
 
queue_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Checkboxboolean
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
IFrameiframe
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
MultiSelecttagarray
Rich Texttext
Timetime

Display position nameDisplay position value
Main1
Additional2

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
Timetime

Display position nameDisplay position value
Main1

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
document_header Accounting Document The Transaction that this Line Item belongs to (DEPRECATED). Private::Accounting::DocumentHeader belongs_to
 
document_header_id 0 1
invoice_document Customer Invoice The Customer Invoice that this Line Item belongs to. Private::Accounting::Invoice belongs_to
 
document_header_id 0 1
location Location The Location associated with this line item Private::Crm::Location belongs_to
 
location_id 0 1
pricing_scheme Pricing scheme The Pricing Scheme that this Line Item uses. Private::Pricebook::PricingScheme belongs_to
 
pricing_scheme_id 0 1
product Product The Product that this Line Item refers to. Private::Pricebook::Product belongs_to
 
product_id 0 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 0 1
supply_scheme Supply scheme The Supply Scheme that this Line Item uses. Private::Pricebook::SupplyScheme belongs_to
 
supply_scheme_id 0 1
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. items
created_by_user Created by The creator of this object. Private::CachedUser belongs_to
 
created_by 0 1
invoices Invoices The set of Customer Invoices on this queue. Private::Accounting::Invoice has_many
 
invoice_queue_id queue_entries 0 Infinity
owner Owner The owner of this object. Private::CachedUser belongs_to
 
owner_id 0 1
queue_entries Queue entries The set of entries on this queue. Private::Accounting::InvoiceQueueEntry has_many
 
queue_id 0 Infinity
updated_by_user Updated by The last updater of this object. Private::CachedUser belongs_to
 
updated_by 0 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameData type value
Checkboxboolean
Currencycurrency
Datedate
Date & timedatetime
Decimal numberdecimal
Email Addressemail_link
IFrameiframe
Integer numberinteger
URLlinkable
Multi-line textmultiline
Percentagepercentage
Phone Numberphone_link
Picklistpicklist
Textstring
MultiSelecttagarray
Rich Texttext
Timetime

Display position nameDisplay position value
Main1
Additional2

Related models

Association nameLabelDescriptionTarget ModelsTypePolymorphic?Foreign keyThroughMin. itemsMax. 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:

Fields

Field nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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 nameLabelDescriptionNull?Filter?Sort?Create?Update?Required?VisibilityDefault valueType (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)