Data Schemas¶
achievement¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
achievement_type_ref |
reference |
|
||
contact_ref |
reference |
|
||
steps |
dict |
|||
start_datetime |
date |
|||
completed_datetime |
date |
|||
expired |
boolean |
|||
finished |
boolean |
|||
coach_ref |
reference |
|
achievement_type¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
category |
string |
|||
sort_order |
number |
|||
active |
boolean |
|||
description |
string |
|||
steps |
string |
list |
||
image |
s3image |
|||
icon |
string |
|||
icon_colour |
string |
|||
experience_required |
string |
|||
objective |
string |
|||
link |
string |
action¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
bulk_action |
boolean |
|||
name |
string |
|||
trigger |
string |
|||
action |
string |
|
||
template |
string |
|||
url |
string |
|||
active |
boolean |
|||
conditional_template |
json_string |
|||
params |
json_string |
|||
query |
dict |
|||
comment |
string |
|||
locked |
boolean |
activity¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
booking |
reference |
|
||
date |
date |
|||
end_date |
date |
|||
start_time |
string |
|||
end_time |
string |
|||
start_datetime |
date |
|||
end_datetime |
date |
|||
bookable |
reference |
set |
bookable |
|
confirmed |
boolean |
|||
hirer |
reference |
|
||
notes |
string |
|||
cancelled |
boolean |
|||
editable_formatted_title |
string |
|||
what |
reference |
bookable |
||
venue |
reference |
venue |
||
allocated_resources |
reference |
set |
bookable |
|
duty_activity |
boolean |
|||
formatted_title |
string |
attendee¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
attendee_name |
string |
A name string used when not creating a person record for the attendee. |
||
attendee_email |
string |
Captured for lookup/reference only. Cannot be used for sending communications to the attendee |
||
guest |
boolean |
|||
person_ref |
reference |
|
||
booking_ref |
reference |
|
||
ticket_ref |
reference |
|
||
status |
string |
|
badge¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
contact_ref |
reference |
|
||
start_date |
date |
|||
end_date |
date |
|||
value |
number |
|||
tags |
string |
set |
||
detail |
string |
|||
editable |
boolean |
bookable¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
external_id |
string |
|||
name |
string |
|||
safe_name |
string |
|||
type |
string |
|
||
ref |
reference |
|
||
short_description |
string |
|||
description |
string |
|||
google_calendar_id |
string |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
files |
s3file |
set |
||
asset_id |
string |
|||
capacity |
number |
|||
hire_cost |
string |
|||
colour |
string |
|||
facilities |
string |
set |
|
|
tags |
string |
set |
||
opening_time |
string |
|||
closing_time |
string |
|||
location |
string |
|||
notes |
string |
|||
active |
boolean |
|||
disable_clash_detection |
boolean |
|||
duty_activity |
boolean |
|||
manage_availability |
boolean |
|||
hireable |
boolean |
|||
enquire_or_reserve |
string |
|
||
default_assets |
reference |
set |
|
booking¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
eventbrite_id |
string |
|||
moodle_id |
string |
|||
eventbrite_last_sync |
date |
|||
series_id |
string |
|||
slug |
string |
|||
title |
string |
|||
formatted_title |
string |
|||
booking_reference |
string |
|||
status |
string |
|
||
tags |
string |
set |
||
progress |
number |
|||
proposed_dates |
date |
set |
||
booking_contact |
reference |
|
||
contacts |
link |
set |
|
|
group |
reference |
set |
|
|
booking_organisation |
reference |
|
||
billing_contact |
reference |
|
||
start_date |
date |
|||
end_date |
date |
|||
start_time |
string |
|||
end_time |
string |
|||
start_datetime |
date |
|||
end_datetime |
date |
|||
date_range |
string |
|||
description |
string |
|||
additional_details |
string |
|||
website |
string |
|||
notes |
string |
|||
files |
s3file |
set |
||
external_image |
s3image |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
booking_type |
string |
|
||
ticketed_event |
boolean |
|||
capacity |
number |
|||
est_numbers |
string |
|||
age_range |
string |
|||
latecomers_allowed |
boolean |
|||
latecomers_policy |
string |
|||
staffed_event |
boolean |
|||
buyer_handling |
string |
|
||
venue_handling |
string |
|
||
location |
string |
|||
location_address_string |
string |
|||
location_postal_code |
string |
|||
location_country |
string |
|||
activity_handling |
string |
|
||
guest_support |
boolean |
|||
media_support |
boolean |
|||
catering_support |
boolean |
|||
catering_support |
boolean |
|||
ticket_choices |
reference |
set |
|
|
checklist |
string |
set |
||
enquiry_date |
date |
|||
enquiry |
boolean |
|||
cancelled |
boolean |
|||
setup_notes |
string |
|||
timing_notes |
string |
|||
takedown_notes |
string |
|||
layout_requirements |
string |
|
||
layout_notes |
string |
|||
access_requirements |
string |
|
||
access_notes |
string |
|||
catering |
boolean |
|||
catering_by |
string |
|
||
catering_notes |
string |
|||
bar_requested |
boolean |
|||
bar_type |
string |
|||
bar_notes |
string |
|||
dietary_requirements |
string |
|||
menu_notes |
string |
|||
photography |
boolean |
|||
music |
boolean |
|||
playlist |
string |
|||
filming |
boolean |
|||
media_notes |
string |
|||
hide_from_self_service |
boolean |
|||
self_service_attendee_details |
string |
|
||
member_only_event |
boolean |
|||
ticket_stock_control |
boolean |
|||
has_available_tickets |
boolean |
|||
hide_banners |
boolean |
|||
is_sold_out |
boolean |
|||
show_map |
boolean |
If sufficient location data exists, show a map. |
||
map_zoom_level |
number |
0 - 15. The zoom level of the map shown to ticket buyers |
||
maximum_ticket_price |
string |
|||
minimum_ticket_price |
string |
|||
start_sales_date |
date |
|||
waitlist_available |
boolean |
|||
use_access_code |
boolean |
|||
controller |
string |
|||
external_web_link |
string |
External listing page for the event |
||
external_boxoffice_link |
string |
External box office / ticket page for the event |
||
lifecycle_emails |
boolean |
|||
featured |
boolean |
Should the event be featured or highlighted? |
||
dates_to_be_confirmed |
boolean |
Are the date still to be confirmed? |
||
extras |
dict |
|||
xero_account_code |
string |
|||
conferencing_url |
string |
|||
conferencing_instructions |
string |
|||
delivered_by |
string |
e.g. the lead speaker of the webinar |
||
delivered_by_photo |
s3image |
|||
delivered_by_background |
string |
comment¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
context |
reference |
|||
key |
string |
|||
title |
string |
|||
thread |
dict |
connection¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
source |
reference |
|
||
destination |
reference |
|
||
automatic |
boolean |
|||
bidirectional |
boolean |
|||
label |
string |
|||
connection_type |
string |
|
||
start_date |
date |
|||
end_date |
date |
|||
hidden |
boolean |
|||
connection_note |
string |
|||
sort_order |
number |
consent¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
reference |
reference |
|
||
source |
string |
|||
source_reference |
string |
|||
channel |
string |
|
||
purpose |
string |
set |
|
|
date |
date |
|||
expiry_date |
date |
|||
withdrawal_date |
date |
|||
context |
string |
|||
context_url |
string |
contact¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
abilities |
string |
|||
active_membership_due |
string |
|||
active_memberships |
string |
|||
active_memberships_for_display |
string |
|||
address_lines |
string |
|||
address_lines_1 |
string |
|||
address_lines_2 |
string |
|||
address_lines_3 |
string |
|||
address_lines_4 |
string |
|||
address_source |
string |
|||
address_source_display |
string |
|||
adult |
string |
|||
advise_lapse |
string |
|||
age |
string |
|||
all_events_attended |
string |
|||
all_events_attended_uris |
string |
|||
all_events_purchased |
string |
|||
all_membership_uris |
string |
|||
all_memberships |
string |
|||
all_memberships_for_display |
string |
|||
allergies |
string |
|||
anniversary |
string |
|||
appeals |
string |
|||
appeals_for_display |
string |
|||
applications_2015_amount |
string |
|||
applications_2015_number |
string |
|||
applications_2016_amount |
string |
|||
applications_2016_number |
string |
|||
applications_2017_amount |
string |
|||
applications_2017_number |
string |
|||
applications_2018_amount |
string |
|||
applications_2018_number |
string |
|||
applications_by_year |
string |
|||
attendee_status |
string |
|||
authorised_pickup |
string |
|||
auto_renew_memberships |
string |
|||
auto_tags |
string |
|||
automatic_email_opt_out |
boolean |
|||
automatic_sms_opt_out |
boolean |
|||
avatar |
string |
|||
badge__90 day Cafe Spend |
string |
|||
badge__90 day Cafe Spend__end |
string |
|||
badge__90 day Cafe Spend__start |
string |
|||
badge__90 day Website Visits |
string |
|||
badge__90 day Website Visits__end |
string |
|||
badge__90 day Website Visits__start |
string |
|||
badge__AAA |
string |
|||
badge__ACP Accreditation__end |
string |
|||
badge__ACP Accreditation__start |
string |
|||
badge__Accredited institution |
string |
|||
badge__Accredited institution__end |
string |
|||
badge__Accredited institution__start |
string |
|||
badge__Album-Blood |
string |
|||
badge__Album-Is Your Love Big Enough? |
string |
|||
badge__Album-Lianne La Havas |
string |
|||
badge__All Mountain - Flaine__end |
string |
|||
badge__All Mountain - Flaine__start |
string |
|||
badge__Audit Rating __end |
string |
|||
badge__Audit Rating __start |
string |
|||
badge__Autism Awareness (UK) |
string |
|||
badge__Autism Awareness (UK)__start |
string |
|||
badge__BG Accreditation__end |
string |
|||
badge__BG Accreditation__start |
string |
|||
badge__Bed of the Year 2021 |
string |
|||
badge__Bed of the Year 2021__start |
string |
|||
badge__BestAlbum-Winner |
string |
|||
badge__BestAlbum-Winner__start |
string |
|||
badge__Blue Iguana__end |
string |
|||
badge__Blue Iguana__start |
string |
|||
badge__Board Member |
string |
|||
badge__Board Member__end |
string |
|||
badge__Board Member__start |
string |
|||
badge__British Gymnastics No__end |
string |
|||
badge__British Gymnastics No__start |
string |
|||
badge__Bursary - Scientific Meeting |
string |
|||
badge__Bursary - Scientific Meeting__start |
string |
|||
badge__Bursary-Membership__end |
string |
|||
badge__Bursary-Membership__start |
string |
|||
badge__Burser__end |
string |
|||
badge__Burser__start |
string |
|||
badge__CPD |
string |
|||
badge__CPD__start |
string |
|||
badge__Club President__end |
string |
|||
badge__Club President__start |
string |
|||
badge__Collection Holder - Dahlia |
string |
|||
badge__Collection Holder - Dahlia__start |
string |
|||
badge__Conference attendance |
string |
|||
badge__Conference attendance__start |
string |
|||
badge__Corporate Accreditation__end |
string |
|||
badge__Corporate Accreditation__start |
string |
|||
badge__Credit for training |
string |
|||
badge__Credit for training__start |
string |
|||
badge__Dog Owner |
string |
|||
badge__Dog Owner__start |
string |
|||
badge__Essential NEDTraining & Certification |
string |
|||
badge__Essential NEDTraining & Certification__start |
string |
|||
badge__Event attedance |
string |
|||
badge__Event attedance__start |
string |
|||
badge__FOC Trophy |
string |
|||
badge__FOC Trophy __end |
string |
|||
badge__FOC Trophy __start |
string |
|||
badge__Fastest Lap - Rally Sim |
string |
|||
badge__Fastest Lap - Rally Sim__start |
string |
|||
badge__Fellow of the Royal Society |
string |
|||
badge__Fellow of the Royal Society__start |
string |
|||
badge__Formula Classic Series |
string |
|||
badge__Formula Classic Series__start |
string |
|||
badge__Founding Member |
string |
|||
badge__Founding Member__start |
string |
|||
badge__FreshTracks-Val d’Isere__end |
string |
|||
badge__FreshTracks-Val d’Isere__start |
string |
|||
badge__GOC__end |
string |
|||
badge__GOC__start |
string |
|||
badge__Hours worked per week |
string |
|||
badge__Hours worked per week__start |
string |
|||
badge__Idenity Card |
string |
|||
badge__Idenity Card__end |
string |
|||
badge__Lifetime Event Travel__end |
string |
|||
badge__Lifetime Event Travel__start |
string |
|||
badge__Lifetime Giving__end |
string |
|||
badge__Lifetime Giving__start |
string |
|||
badge__Long Service |
string |
|||
badge__Lord Mayor of Belfast__end |
string |
|||
badge__Lord Mayor of Belfast__start |
string |
|||
badge__MLA Grant__end |
string |
|||
badge__MLA Grant__start |
string |
|||
badge__MP for Belfast East |
string |
|||
badge__MP for Belfast East__start |
string |
|||
badge__MailChimp opens |
string |
|||
badge__MailChimp opens__end |
string |
|||
badge__MailChimp opens__start |
string |
|||
badge__Meeting |
string |
|||
badge__Meeting__start |
string |
|||
badge__Membership Sale |
string |
|||
badge__Membership Sale__start |
string |
|||
badge__NED Certifcate |
string |
|||
badge__NED Certifcate__end |
string |
|||
badge__NED Certifcate__start |
string |
|||
badge__Passport__end |
string |
|||
badge__Passport__start |
string |
|||
badge__Qualification date |
date |
|||
badge__Qualification date__start |
date |
|||
badge__Quality Assurance__end |
string |
|||
badge__Quality Assurance__start |
string |
|||
badge__Regulation GOC |
string |
|||
badge__Revoked Membership |
string |
|||
badge__Revoked Membership __start |
string |
|||
badge__Sales Prospect |
string |
|||
badge__Sales Prospect __start |
string |
|||
badge__Score__end |
string |
|||
badge__Score__start |
string |
|||
badge__Security |
string |
|||
badge__Ski Rep - Whistler |
string |
|||
badge__Ski Rep - Whistler__start |
string |
|||
badge__Star Rating__end |
string |
|||
badge__Star Rating__start |
string |
|||
badge__The BDMA Certificate in Site Health & Safety (ComTech Part 1)__end |
string |
|||
badge__The BDMA Certificate in Site Health & Safety (ComTech Part 1)__start |
string |
|||
badge__Trees |
string |
|||
badge__Trees__start |
string |
|||
badge__Visitor Attendance__end |
string |
|||
badge__Visitor Attendance__start |
string |
|||
badge__Website Views |
string |
|||
badge__Website Views__start |
string |
|||
badge__attendance |
string |
|||
badge__attendance__end |
string |
|||
badge__attendance__start |
string |
|||
badge__badge example |
string |
|||
badge__badge example__end |
string |
|||
badge__badge example__start |
string |
|||
badge__funding award |
string |
|||
badge__funding award__start |
string |
|||
badge__self_service_useraccount |
string |
|||
badge__self_service_useraccount__start |
string |
|||
badge__test |
string |
|||
badge__test 2 |
string |
|||
badge__test 3 |
string |
|||
badge__test new badge__end |
string |
|||
badge__test new badge__start |
string |
|||
badge__test test test |
string |
|||
badge__test2 |
string |
|||
badge__you ain’t never seen this badge |
string |
|||
badges |
string |
|||
base_record_last_updated |
date |
|||
bio |
string |
|||
birth_day |
string |
|||
birth_month |
string |
|||
caf_uid |
string |
|||
charity_number |
string |
|||
colour |
string |
|||
comms_permission |
string |
|||
company_number |
string |
|||
connections |
string |
|||
country |
string |
|||
created |
string |
|||
date_last_tetanus_booster |
date |
|||
date_of_birth |
date |
|||
date_of_death |
date |
|||
dbs |
string |
|||
dbs_status |
string |
|||
deceased |
string |
|||
dietary_requirements |
string |
|||
display_value |
string |
|||
domain |
string |
|||
domain_name |
string |
|||
domains |
string |
|||
donations_made |
string |
|||
donor_tags |
string |
|||
driving_licence |
string |
|||
earliest_allocation |
string |
|||
editable_formatted_name |
string |
|||
editable_salutation |
string |
|||
string |
||||
email_domains |
string |
|||
email_opt_out |
boolean |
|||
email_source |
string |
|||
email_source_display |
string |
|||
emergency_contact_details |
string |
|||
emergency_contact_details_2 |
string |
|||
employer |
string |
|||
english_region |
string |
|||
epipen |
string |
|||
evidence |
string |
|||
evidence_categories |
string |
|||
evidence_expired |
string |
|||
expertise |
string |
|||
external_ids |
string |
|||
external_photo_url |
string |
|||
externalid_clearance code |
string |
|||
externalid_clearbit |
string |
|||
externalid_gocardless |
string |
|||
externalid_gocardless_last_sync |
string |
|||
externalid_mailchimp |
string |
|||
externalid_mailchimp_last_sync |
string |
|||
externalid_s1313 |
string |
|||
externalid_stripe |
string |
|||
externalid_test 1 |
string |
|||
externalid_xeros |
string |
|||
extras |
string |
|||
facebook_username |
string |
|||
family_address_heading |
string |
|||
family_formal_salutation |
string |
|||
family_informal_salutation |
string |
|||
family_members |
string |
|||
family_primary |
string |
|||
family_ref |
string |
|||
family_salutation |
string |
|||
favicon |
string |
|||
first_application |
string |
|||
first_donation |
string |
|||
first_donation_date |
date |
|||
first_event |
string |
|||
first_event_date |
date |
|||
first_event_uri |
string |
|||
first_form_submission |
string |
|||
first_membership_date |
date |
|||
first_membership_type |
string |
|||
first_membership_uri |
string |
|||
first_name |
string |
|||
first_pledge |
string |
|||
first_pledge_ref |
string |
|||
formal_salutation |
string |
|||
formatted_name |
string |
|||
forms |
string |
|||
gdpr_can_1111111 |
string |
|||
gdpr_can_asdasdasd |
string |
|||
gdpr_can_email |
string |
|||
gdpr_can_phone |
string |
|||
gdpr_can_post |
string |
|||
gdpr_can_process |
string |
|||
gdpr_can_telephone |
string |
|||
gdpr_consent_to_email |
string |
|||
gdpr_last_updated |
date |
|||
gdpr_purpose_channels |
string |
|||
gender |
string |
|||
geo |
string |
|||
gocardless_uid |
string |
|||
gp_name |
string |
|||
gp_phone |
string |
|||
gp_postal_code |
string |
|||
gp_surgery_address_lines |
string |
|||
grant_applications |
string |
|||
grant_applications_total |
string |
|||
grant_tags |
string |
|||
granted_2015_amount |
string |
|||
granted_2016_amount |
string |
|||
granted_2017_amount |
string |
|||
granted_2018_amount |
string |
|||
granted_total |
string |
|||
group_accepted_date |
date |
|||
group_categories |
string |
|||
group_role |
string |
|||
groups |
string |
|||
groups_accepted |
string |
|||
groups_applied |
string |
|||
groups_cancelled |
string |
|||
groups_checking |
string |
|||
groups_flagged |
string |
|||
groups_follower |
string |
|||
groups_ready-for-references |
string |
|||
groups_rejected |
string |
|||
groups_started |
string |
|||
groups_waiting |
string |
|||
has_abilities |
boolean |
|||
has_address_lines |
boolean |
|||
has_advise_lapse |
boolean |
|||
has_allergies |
boolean |
|||
has_deceased |
boolean |
|||
has_dietary_requirements |
boolean |
|||
has_different_mailing_address |
boolean |
|||
has_direct_debit_mandate |
date |
|||
has_email |
boolean |
|||
has_email_opt_out |
boolean |
|||
has_epipen |
boolean |
|||
has_externalid_caf |
boolean |
|||
has_externalid_gocardless |
boolean |
|||
has_externalid_larn |
boolean |
|||
has_externalid_stripe |
boolean |
|||
has_externalid_xero |
boolean |
|||
has_gift_aid_declaration |
boolean |
|||
has_health_data |
boolean |
|||
has_own_membership |
boolean |
|||
has_paid_active_membership |
boolean |
|||
has_paid_last_membership |
boolean |
|||
has_photo |
boolean |
|||
has_primary_contact_for_family |
boolean |
|||
has_reservation_hires |
boolean |
|||
has_shared_address_lines |
boolean |
|||
has_sheepcrm_useraccount |
boolean |
|||
has_telephone |
boolean |
|||
has_useraccount |
boolean |
|||
has_website |
boolean |
|||
hide_from_views |
string |
|||
industry |
string |
|||
inhaler |
string |
|||
initial |
string |
|||
instagram_username |
string |
|||
interests |
string |
|||
invoices |
string |
|||
is_last_membership_admin |
string |
|||
is_last_membership_billing |
string |
|||
is_last_membership_member |
string |
|||
iso_country |
string |
|||
job_title |
string |
|||
journal_tags |
string |
|||
known_as |
string |
|||
language |
string |
|||
last_activity_by |
string |
|||
last_activity_date |
date |
|||
last_application |
string |
|||
last_application_status |
string |
|||
last_donation |
string |
|||
last_donation_amount_display |
string |
|||
last_donation_date |
date |
|||
last_event |
string |
|||
last_event_date |
date |
|||
last_event_uri |
string |
|||
last_granted |
string |
|||
last_membership_admin_contact |
string |
|||
last_membership_admin_contact_name |
string |
|||
last_membership_billing_contact |
string |
|||
last_membership_billing_contact_name |
string |
|||
last_membership_created |
string |
|||
last_membership_due |
string |
|||
last_membership_end_date |
date |
|||
last_membership_linked_members |
string |
|||
last_membership_member |
string |
|||
last_membership_number |
string |
|||
last_membership_number_numeric |
string |
|||
last_membership_start_date |
date |
|||
last_membership_type |
string |
|||
last_membership_type_display |
string |
|||
last_membership_updated |
date |
|||
last_membership_uri |
string |
|||
last_name |
string |
|||
last_pledge |
string |
|||
last_pledge_ref |
string |
|||
last_renewal_date |
date |
|||
last_updated |
date |
|||
latest_allocation |
string |
|||
legacy_uid |
string |
|||
lifetime_donations_by_currency |
string |
|||
lifetime_total |
string |
|||
lifetime_total_display |
string |
|||
linked_email |
string |
|||
linked_memberships |
string |
|||
linked_memberships_display |
string |
|||
linkedin_public_profile |
string |
|||
locality |
string |
|||
mailchimp_last_sync |
string |
|||
mailing_address_lines |
string |
|||
mailing_address_lines_1 |
string |
|||
mailing_address_lines_2 |
string |
|||
mailing_address_lines_3 |
string |
|||
mailing_address_lines_4 |
string |
|||
mailing_contact |
string |
|||
mailing_contact_display_value |
string |
|||
mailing_country |
string |
|||
mailing_locality |
string |
|||
mailing_postal_code |
string |
|||
mailing_region |
string |
|||
mailsort_code |
string |
|||
mc_tags |
string |
|||
medical_history |
string |
|||
medication |
string |
|||
member_original_join_date |
date |
|||
member_since |
string |
|||
member_tags |
string |
|||
member_till |
string |
|||
member_till_plus_grace |
string |
|||
membership_last_updated |
date |
|||
membership_numbers |
string |
|||
membership_record_status |
string |
|||
mobile |
string |
|||
naics_code |
string |
|||
name |
string |
|||
name_suffix |
string |
|||
next_event |
string |
|||
next_event_date |
date |
|||
next_event_uri |
string |
|||
next_renewal_date |
date |
|||
next_renewal_days_away |
string |
|||
next_renewal_month |
string |
|||
next_renewal_year |
string |
|||
nhs_number |
string |
|||
no_group |
string |
|||
notes |
string |
|||
number_events_attended |
string |
|||
number_events_purchased |
string |
|||
number_no_shows |
string |
|||
number_of_active_membership_records |
string |
|||
number_of_applications |
string |
|||
number_of_donations |
string |
|||
number_of_employees |
string |
|||
number_of_invoices |
string |
|||
number_of_membership_records |
string |
|||
number_of_open_invoices |
string |
|||
number_of_pledges |
string |
|||
number_of_vehicles |
string |
|||
open_invoices |
string |
|||
org_connection_type |
string |
|||
organisation |
string |
|||
organisation_display_value |
string |
|||
organisation_type |
string |
|||
payment_count |
string |
|||
payment_currencies |
string |
|||
payment_future_total_aed |
string |
|||
payment_future_total_aud |
string |
|||
payment_future_total_bbd |
string |
|||
payment_future_total_bwp |
string |
|||
payment_future_total_eur |
string |
|||
payment_future_total_gbp |
string |
|||
payment_future_total_jpy |
string |
|||
payment_future_total_mad |
string |
|||
payment_future_total_php |
string |
|||
payment_future_total_sgd |
string |
|||
payment_future_total_usd |
string |
|||
payment_processors |
string |
|||
payment_total_aed |
string |
|||
payment_total_aed_gocardless (direct debit) |
string |
|||
payment_total_aed_membership_payment |
string |
|||
payment_total_aud |
string |
|||
payment_total_aud_bacs |
string |
|||
payment_total_aud_bookable |
string |
|||
payment_total_aud_caf |
string |
|||
payment_total_aud_cash |
string |
|||
payment_total_aud_cheque |
string |
|||
payment_total_aud_credit/debit card |
string |
|||
payment_total_aud_direct debit |
string |
|||
payment_total_aud_donation |
string |
|||
payment_total_aud_faster payment |
string |
|||
payment_total_aud_gocardless |
string |
|||
payment_total_aud_membership_payment |
string |
|||
payment_total_aud_other |
string |
|||
payment_total_aud_paypal |
string |
|||
payment_total_aud_scheduled |
string |
|||
payment_total_aud_stripe |
string |
|||
payment_total_aud_ticket_payment |
string |
|||
payment_total_bbd |
string |
|||
payment_total_bbd_bacs |
string |
|||
payment_total_bbd_ticket_payment |
string |
|||
payment_total_bwp |
string |
|||
payment_total_bwp_caf |
string |
|||
payment_total_bwp_ticket_payment |
string |
|||
payment_total_eur |
string |
|||
payment_total_eur_credit/debit card |
string |
|||
payment_total_eur_gocardless |
string |
|||
payment_total_eur_membership_payment |
string |
|||
payment_total_eur_scheduled |
string |
|||
payment_total_gbp |
string |
|||
payment_total_gbp_bacs |
string |
|||
payment_total_gbp_bookable |
string |
|||
payment_total_gbp_caf |
string |
|||
payment_total_gbp_cash |
string |
|||
payment_total_gbp_cheque |
string |
|||
payment_total_gbp_credit/debit card |
string |
|||
payment_total_gbp_direct debit |
string |
|||
payment_total_gbp_donation |
string |
|||
payment_total_gbp_eventbrite |
string |
|||
payment_total_gbp_expected |
string |
|||
payment_total_gbp_failed |
string |
|||
payment_total_gbp_gocardless |
string |
|||
payment_total_gbp_gocardless (direct debit) |
string |
|||
payment_total_gbp_gocardless - direct debit |
string |
|||
payment_total_gbp_invoice |
string |
|||
payment_total_gbp_membership_payment |
string |
|||
payment_total_gbp_other |
string |
|||
payment_total_gbp_paypal |
string |
|||
payment_total_gbp_scheduled |
string |
|||
payment_total_gbp_standing order |
string |
|||
payment_total_gbp_stripe |
string |
|||
payment_total_gbp_ticket |
string |
|||
payment_total_gbp_ticket_payment |
string |
|||
payment_total_gbp_voucher |
string |
|||
payment_total_jpy |
string |
|||
payment_total_jpy_direct debit |
string |
|||
payment_total_mad |
string |
|||
payment_total_mad_bacs |
string |
|||
payment_total_mad_cash |
string |
|||
payment_total_php |
string |
|||
payment_total_php_cash |
string |
|||
payment_total_php_gocardless |
string |
|||
payment_total_php_ticket_payment |
string |
|||
payment_total_sgd |
string |
|||
payment_total_sgd_membership_payment |
string |
|||
payment_total_sgd_stripe |
string |
|||
payment_total_sgd_ticket_payment |
string |
|||
payment_total_usd |
string |
|||
payment_total_usd_cash |
string |
|||
payment_total_usd_ticket_payment |
string |
|||
payment_types |
string |
|||
person_org_hybrid |
string |
|||
photo |
string |
|||
photo-avatar |
string |
|||
photo-favicon |
string |
|||
photo-large |
string |
|||
photo-large34ratio |
string |
|||
photo-largeprofile |
string |
|||
photo-largeretina |
string |
|||
photo-profile |
string |
|||
photo_required |
string |
|||
postal_code |
string |
|||
postal_code_outward |
string |
|||
primary_email |
string |
|||
primary_service_offered |
string |
|||
primary_telephone |
string |
|||
pronoun |
string |
|||
recurring_donation_increment |
string |
|||
recurring_donation_next_increment_date |
date |
|||
recurring_donation_type |
string |
|||
region |
string |
|||
reservation_first_hire_date |
date |
|||
reservation_hired_spaces |
string |
|||
reservation_last_hire_date |
date |
|||
reservation_number_of_hires |
string |
|||
resource_icon |
string |
|||
resource_type |
string |
|||
restrictions |
string |
|||
restrictions_for_display |
string |
|||
royal_mail_international_zone |
string |
|||
salutation |
string |
|||
school |
string |
|||
school_year |
string |
|||
school_year_modifier |
string |
|||
sector |
string |
|||
segments |
string |
|||
segments_for_display |
string |
|||
sen |
string |
|||
services_offered |
string |
|||
sheepcrm_useraccount |
string |
|||
sheepcrm_useraccount_created |
string |
|||
sheepcrm_useraccount_email |
string |
|||
sheepcrm_useraccount_last_login_date |
date |
|||
sic_code |
string |
|||
sic_two_digit_code |
string |
|||
skype_username |
string |
|||
sortable_name |
string |
|||
source |
string |
|||
stripe_last_sync |
string |
|||
stripe_uid |
string |
|||
subtitle |
string |
|||
summary |
string |
|||
tags |
string |
|||
telephone |
string |
|||
telephone_cleaned |
string |
|||
telephone_source |
string |
|||
test |
string |
|||
ticket_ids |
string |
|||
ticket_purchase_status |
string |
|||
ticket_types |
string |
|||
time_zone |
string |
|||
title |
string |
|||
total_number_tickets_purchased |
string |
|||
trading_name |
string |
|||
turnover_band |
string |
|||
twitter_username |
string |
|||
uri |
string |
|||
useraccount |
string |
|||
useraccount_build |
string |
|||
useraccount_created |
string |
|||
useraccount_email |
string |
|||
useraccount_last_login_date |
date |
|||
useraccount_status |
string |
|||
vaccination_programme |
string |
|||
vat_number |
string |
|||
vat_registered |
string |
|||
vehicle_make |
string |
|||
vehicle_registration_number |
string |
|||
vehicle_type |
string |
|||
vehicles |
string |
|||
vend_uid |
string |
|||
website |
string |
|||
website_description |
string |
|||
website_image |
string |
|||
xero_last_sync |
string |
|||
xero_uid |
string |
contract¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
person |
reference |
|
||
processing_operation |
reference |
|
||
start_date |
date |
|||
end_date |
date |
|||
reference |
reference |
|
||
channels |
string |
set |
|
dbs¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
person |
reference |
|
||
dbs_number |
string |
|||
reported_status |
string |
|||
check_date |
date |
|||
print_date |
date |
|||
check_method |
string |
|
||
status_check_permission |
boolean |
donation¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
pledge |
reference |
|
||
donor |
reference |
|
||
payment |
reference |
|
||
payment_reconciled |
boolean |
|||
amount |
number |
|||
currency |
string |
|||
date |
date |
|||
method |
string |
|||
appeal |
reference |
|
||
restricted_to |
reference |
|
||
gift_aid |
boolean |
donation_appeal¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
donation_appeal |
string |
|||
short_description |
string |
|||
description |
string |
|||
summary |
string |
|||
thank_text |
string |
|||
active |
boolean |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
target_amount |
number |
|||
target_currency |
string |
|||
office_only |
boolean |
|||
accepting_donations |
boolean |
|||
featured |
boolean |
|||
start_date |
date |
|||
end_date |
date |
|||
disable_recurring |
boolean |
donation_restriction¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
donation_restriction |
string |
|||
active |
boolean |
|||
short_description |
string |
equal_opportunities¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
reference_number |
string |
|||
person |
reference |
|
||
gender |
string |
|
||
marital_status |
string |
|
||
age |
number |
|||
ethnicity |
string |
|
||
ethnic_group_short |
string |
|
||
ethnic_group |
string |
|
||
white_ethnicity |
string |
|
||
mixed_race |
string |
|
||
asian_ethnicity |
string |
|
||
black_ethnicity |
string |
|
||
other_ethnicity |
string |
|
||
disability |
string |
|
||
disability_type |
string |
set |
|
|
sexual_orientation |
string |
|
||
trans |
string |
|
||
religious_belief |
string |
|
||
current_working_pattern |
string |
|
||
flexible_working_arrangement |
string |
|
||
caring_responsibilities |
string |
|
evidence¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
category |
string |
|
||
source |
string |
|||
source_ref |
string |
|||
access_code |
string |
|||
contact_ref |
reference |
|
||
context |
reference |
set |
|
|
document_date |
date |
|||
seen_date |
date |
|||
expiry_date |
date |
|||
files |
s3file |
set |
||
tags |
string |
set |
||
text |
string |
externalid¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
ref |
reference |
|
||
domain |
string |
|||
uid |
string |
|||
last_sync |
date |
flow_board¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
creator |
string |
|||
description |
string |
|||
active |
boolean |
|||
resource_type |
string |
|
||
user_groups |
reference |
set |
|
|
users |
string |
set |
||
columns |
dict |
|||
base_filter |
dict |
|||
default_filter |
dict |
|||
tags |
string |
set |
flock_settings¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
flock_name_public |
string |
|||
flock_name_public_short |
string |
|||
gift_aid_rate |
number |
|||
standard_tax_rate |
number |
|||
lower_tax_rate |
number |
|||
default_currency |
string |
|
||
multi_currency |
boolean |
|||
vat_number |
string |
|||
financial_year_day |
number |
|||
financial_year_month |
number |
|||
gift_aid_scope |
string |
set |
|
|
mandate_scope |
string |
set |
|
|
invoice_contact_details |
string |
|||
invoice_template |
string |
|
||
invoice_disable_tax |
boolean |
|||
invoice_payment_details |
string |
|||
invoice_payment_detail_notes |
string |
|||
invoice_email |
string |
|||
self_service_invoices |
boolean |
|||
invoice_show_multiple_currencies |
boolean |
|||
utr |
string |
|||
purchase_order_string |
string |
|||
disable_auto_tags |
boolean |
|||
automated_tagging |
string |
|||
retention_years |
number |
Data retention policy - number of years since last activity |
||
send_reminder_emails |
boolean |
|||
hide_cancelled_in_calendar |
boolean |
|||
sheep_auto_email_bcc |
string |
|||
membership_grace_period |
number |
The period, in days, after a membership has lapsed during which a member can renew and retain continuous membership. |
||
membership_renew_window |
number |
The period, in days, before which a membership cannot be renewed. (Memberships can only be renewed when within the renewal window). A blank or zero value will allow renewals at any time. |
||
auto_membership_number |
boolean |
|||
initial_membership_number |
number |
|||
random_auto_membership_number |
boolean |
|||
membership_intro_text |
string |
|||
membership_signupline |
string |
|||
membership_confirm_intro_text |
string |
|||
membership_interests_intro |
string |
|||
membership_thank_text_new |
string |
|||
membership_thank_text_renew |
string |
|||
membership_almost_done_button_text |
string |
|||
membership_on_finish_name |
string |
|||
membership_enabled |
boolean |
|||
membership_enable_new_registrations |
boolean |
|||
membership_allow_multiple |
boolean |
|||
membership_manage_linked_members |
boolean |
|||
membership_linked_member_noun |
string |
|||
membership_max_plans_to_show |
number |
|||
membership_on_finish_path |
string |
|||
membership_certificates |
boolean |
|||
membership_certificate_template |
string |
|||
membership_cards |
boolean |
|||
membership_documents_active_only |
boolean |
|||
membership_documents_paid_only |
boolean |
|||
membership_change_on_renew |
boolean |
|||
team_roles |
string |
set |
||
team_self_service_events |
string |
|
control how team and central events are listed in the app |
|
team_self_service_attendee_details |
string |
|
||
available_comms_channels |
string |
set |
|
|
concurrent_volunteer_application_limit |
number |
|||
holiday_carryover |
number |
|||
locked_tags |
string |
set |
||
connections |
string |
set |
||
domain_connections_exclusions |
string |
set |
list domains here that should not be used to created automatic connections |
|
interest_groups |
string |
set |
||
mailchimp_usage |
string |
|
||
discourse_usage |
string |
|
||
dial9_usage |
string |
|
||
dropbox_usage |
string |
|
||
email_dropbox_usage |
string |
|
||
eventbrite_usage |
string |
|
||
gocardless_usage |
string |
|
||
loqate_usage |
string |
|
||
stripe_usage |
string |
|
||
xero_usage |
string |
|
||
xero_account_code_membership |
string |
|||
xero_account_code_donations |
string |
|||
xero_account_code_events |
string |
|||
xero_use_sheep_invoice_numbers |
boolean |
|||
address_lines |
string |
list |
||
postal_code |
string |
|||
phone |
string |
|||
string |
||||
contact_email |
string |
|||
charity_number |
string |
|||
company_number |
string |
|||
company_name_registered |
string |
|||
company_place_of_registration |
string |
|||
company_registered_office |
string |
|||
website |
string |
|||
string |
||||
string |
||||
string |
||||
string |
||||
youtube |
string |
|||
flock_logo |
s3image |
|||
flock_logo_square |
s3image |
|||
flock_logo_monochrome |
s3image |
|||
flock_banner_image |
s3image |
|||
flock_letter_head_image |
s3image |
|||
name_in_logo |
boolean |
|||
hide_logo |
boolean |
|||
app_colour |
string |
|||
brand_colour |
string |
|||
header_font_treatment |
string |
|||
eventsReturnAddress |
string |
|||
websiteReturnAddress |
string |
|||
default_salutation |
string |
|||
default_female_salutation |
string |
|||
giving_enabled |
boolean |
|||
giving_email_address |
string |
Enter an email address which should be used for any enquiries regarding donations. |
||
minimum_donation |
number |
Enter the minimum donation amount you wish to accept through sheepApp. |
||
suggested_amount |
number |
|||
available_amounts |
number |
list |
Enter each preset or suggested donation amount for donors to quickly select instead of entering a custom amount. |
|
giving_noun |
string |
Override the default label shown in the sheepApp Giving section. sheepCRM uses “Appeal” but your organisation might use e.g. “Cause”, “Event”, “Area of support” |
||
giving_plural |
string |
Override the default label shown in the sheepApp Giving section. sheepCRM uses “Appeals” but your organisation might use e.g. “Causes”, “Events”, “Areas of support” |
||
giving_section_heading |
string |
Override the default heading shown in the sheepApp Giving section. sheepCRM uses “Browse Appeals” but your organisation might use e.g. “Make a Donation”, “Donate to Events”, “Browse Areas of Support” |
||
giving_verb |
string |
Override the default prompt or action button shown in the sheepApp Giving section. sheepCRM uses “Make a Donation” but your organisation might use e.g. “Donate now”, “Make a Pledge”, “Start donation” |
||
giving_featured_word |
string |
Featured appeals will be displayed more prominently in sheepApp. These will have a small banner with “Featured” but this word can be changed if your organisation prefers a different term e.g. “Urgent”, “Special” |
||
giving_cta_heading |
string |
Override the default header shown in the sheepApp Giving section. |
||
giving_cta_sentence |
string |
Appeals in sheepApp have a dedicated space for a call-to-action to encourage people to donate, placed near the donate button. This can be overridden on an individual appeal, but a standard message can be entered here. |
||
giving_terms_heading |
string |
Appeals in sheepApp can have a space at the bottom to display additional information or terms and conditions for donations. If being used, enter a heading for this section. |
||
giving_terms_content |
string |
Appeals in the sheepApp can have a space at the bottom to display additional information or terms and conditions for donations. If being used, enter the content for this section. |
||
giving_thank_heading |
string |
|||
giving_thank_content |
string |
|||
giving_document_cta_heading |
string |
|||
giving_document_cta_content |
string |
|||
giving_icon |
string |
|||
feedback_reminder |
boolean |
Turn on if you want sheepCRM to automatically create reminders when a user provides feedback |
||
feedback_reminder_assignee |
reference |
|
Choose the user who should be assigned the feedback tasks |
|
index_journal_tags |
boolean |
include tags from journals in the warehouse |
||
index_deceased_contacts |
boolean |
include deceased contacts in the warehouse |
||
index_sensitive_details |
boolean |
include sensitive details (e.g. health) data in the warehouse |
||
local_outer_postal_codes |
string |
|||
sms_tokens |
number |
|||
clearbit_tokens |
number |
form_question¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
field |
string |
|||
label |
string |
|||
helper_text |
string |
|||
type |
string |
|
||
visibility |
string |
|
||
required |
boolean |
|||
disabled |
boolean |
|||
choices |
string |
list |
||
choices_url |
string |
|||
core_field |
string |
|||
core_field_update_policy |
string |
|
||
min_word_limit |
number |
|||
max_word_limit |
number |
|||
marks_available |
number |
form_response¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
form_ref |
reference |
|
||
contact_ref |
reference |
|
||
context_ref |
reference |
set |
|
|
submission_date |
date |
|||
status |
string |
|||
response |
dict |
|||
section_feedback |
dict |
|||
section_internal_comments |
dict |
|||
overall_feedback |
string |
|||
overall_internal_comments |
string |
|||
score |
number |
|||
score_sheet |
dict |
|||
tags |
string |
set |
||
users |
string |
set |
||
review_by_date |
date |
|||
expiry_date |
date |
form_section¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
title |
string |
|||
subtitle |
string |
|||
intro |
string |
|||
footer |
string |
|||
ref |
string |
|||
conditions |
dict |
|||
questions |
reference |
list |
|
|
feedback |
boolean |
|||
internal_comments |
boolean |
|||
scoring |
boolean |
|||
marks |
number |
form_template¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
sections |
reference |
list |
|
|
conditional_section_logic |
json_string |
deprecated - conditional logic should be added to the section |
grant¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
funder |
reference |
|
||
restricted_to |
reference |
|
||
amount |
number |
|||
currency |
string |
|
||
date |
date |
|||
status |
string |
|
||
conditions |
string |
|||
files |
s3file |
list |
||
notes |
string |
|||
thanked |
boolean |
|||
category |
string |
set |
grant_award¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
grant_reference_number |
string |
|||
contact_ref |
reference |
|
||
form_application_ref |
reference |
|
||
total |
string |
|||
currency |
string |
|
||
period |
string |
|||
award_date |
date |
|||
first_payment_date |
date |
|||
reporting_date |
date |
|||
payment_schedule |
string |
|||
conditions |
string |
|||
description |
string |
|||
grant_type |
string |
|
||
status |
string |
|
||
tags |
string |
set |
grant_data¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
organisation |
reference |
|
||
purpose |
string |
|||
sectors |
string |
set |
||
max_grant_amount |
number |
|||
application_frequency |
string |
|
||
season |
string |
|
||
application_method |
string |
|
||
trust_value |
number |
|||
conditions |
string |
group¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
category |
string |
|||
subcategory |
string |
|||
short_description |
string |
|||
description |
string |
|||
how_to_apply |
string |
|||
entry_requirements |
string |
|||
skills_required |
string |
|||
what_you_will_do |
string |
|||
additional_details |
string |
|||
important_information |
string |
|||
renuneration |
string |
|||
remuneration |
string |
|||
working_pattern |
string |
|||
active |
boolean |
|||
joining_policy |
string |
|
||
invite_only |
boolean |
|||
application_form |
reference |
sheep_form |
||
member_only |
boolean |
|||
invite_code |
string |
|||
tags |
string |
set |
||
leader |
reference |
set |
person |
|
min |
number |
|||
max |
number |
|||
reapply_to_group |
reference |
group |
||
location |
string |
|||
location_address_string |
string |
|||
location_postal_code |
string |
|||
location_country |
string |
|||
location_photo |
s3image |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
group_member¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
person |
reference |
person |
||
application_form_response |
reference |
form_response |
||
group |
reference |
group |
||
role |
string |
|
||
status |
string |
|
||
extra |
json_string |
|||
tags |
string |
set |
health¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
person |
reference |
|
||
gp_name |
string |
|||
gp_surgery_address_lines |
string |
list |
||
gp_postal_code |
string |
|||
gp_phone |
string |
|||
medical_history |
string |
|||
medication |
string |
|||
allergies |
string |
|||
dietary_requirements |
string |
|||
epipen |
boolean |
has (and therefore needs) epipen |
||
inhaler |
boolean |
has (and therefore needs) inhaler |
||
vaccination_programme |
boolean |
has completed standard childhood vaccinations |
||
date_last_tetanus_booster |
date |
|||
nhs_number |
string |
|||
health_notes |
string |
|||
consent_for_first_aid |
boolean |
|||
consent_for_hospital |
boolean |
|||
consent_for_painkillers |
boolean |
hiring_slot_definition¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
label |
string |
|||
category |
string |
|||
active |
boolean |
|||
reserved |
boolean |
|||
constraint_text |
string |
|||
min_buffer_before_minutes |
number |
|||
min_buffer_after_minutes |
number |
|||
list_price |
string |
|||
currency |
string |
|
||
tax |
string |
|
||
start_time |
string |
|||
end_time |
string |
|||
days_of_week |
number |
list |
||
hide_ineligible |
boolean |
|||
tags |
string |
set |
||
constraints |
dict |
|||
price_constraints |
dict |
journal¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
entity |
reference |
|
||
context |
reference |
|
||
assigned_to |
reference |
|
||
trigger_resource_ref |
tuple |
|||
creator |
string |
|||
title |
string |
|||
creator_reference |
string |
|||
body |
string |
|||
text_body |
string |
|||
date |
date |
|||
link |
string |
|||
entry_type |
string |
|||
entry_subtype |
string |
|||
files |
s3file |
set |
||
tags |
string |
set |
||
star |
boolean |
lawful_basis¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
reference |
reference |
|
||
basis |
string |
|
||
processing_operation |
reference |
|
||
date |
date |
|||
end_date |
date |
legitimate_interest¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
reference |
reference |
|
||
source |
string |
|||
source_reference |
string |
|||
channel |
string |
|
||
purpose |
string |
|||
date |
date |
|||
expiry_date |
date |
|||
withdrawal_date |
date |
|||
context |
string |
|||
context_url |
string |
|||
assessment_location |
string |
|||
can_opt_out |
boolean |
lineitem¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
ref |
reference |
service_type |
||
name |
string |
|||
price |
number |
|||
quantity |
number |
|||
total |
number |
|||
tax_total |
number |
|||
quote_ref |
reference |
|
||
currency |
string |
|||
tax_rate |
number |
|||
tax |
string |
|
||
attendees |
reference |
list |
person |
|
xero_account_code |
string |
|||
position |
number |
mandate¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
contact_ref |
reference |
|
||
partner |
string |
|||
scheme |
string |
|
||
account_holder |
string |
|||
bank_account_summary |
string |
|||
reference |
string |
|||
status |
string |
|
||
start_date |
date |
|||
end_date |
date |
|||
mandate_scope |
string |
set |
|
member¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
membership_record_status |
string |
|
||
membership_number |
string |
|||
member |
reference |
|
||
admin_contact |
reference |
|
||
billing_contact |
reference |
|
||
linked_members |
reference |
set |
|
|
membership_plan_type |
string |
|||
period |
string |
|
||
max_linked_members |
number |
|||
membership_type |
reference |
|
||
next_membership_type |
reference |
|
used for auto-renew |
|
start_date |
date |
|||
end_date |
date |
|||
cancellation_date |
date |
|||
paid |
boolean |
|||
amount |
number |
|||
currency |
string |
|
||
xero_account_code |
string |
|||
tax |
string |
|
||
advise_lapse |
boolean |
advise_lapse: the member has decided not to renew. Membership will continue until the scheduled end date. Auto renew if set will be turned off. |
||
lapse_reason |
string |
lapse or cancellation reason |
||
auto_renew |
boolean |
|||
gift_aid |
boolean |
|||
externally_managed |
boolean |
externally_managed: for memberships that are fully managed by an third party. |
||
mute_communications |
boolean |
mute_communications: stop communcations just for this memberships. |
||
payment_date |
date |
|||
payment_method |
string |
|||
payment_reference |
string |
|||
gc_subscription_id |
string |
|||
stripe_subscription_id |
string |
|||
tags |
string |
set |
||
extra |
json_string |
|||
payment_plan |
reference |
|
||
next_payment_plan |
reference |
|
||
has_renewed |
boolean |
membership¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
first_name |
string |
|||
last_name |
string |
|||
title |
string |
|||
address_lines |
string |
list |
||
locality |
string |
|||
region |
string |
|||
postal_code |
string |
|||
country |
string |
|||
telephone |
tuple |
list |
||
tuple |
||||
date_of_birth |
date |
|||
gender |
string |
|
||
external_photo_url |
string |
|||
job_title |
string |
|||
tags |
string |
set |
||
website |
string |
|||
email_opt_out |
boolean |
|||
membership_number |
string |
|||
membership_type |
reference |
|
||
start_date |
date |
|||
end_date |
date |
|||
amount |
number |
|||
gift_aid |
boolean |
|||
currency |
string |
|
||
payment_processor |
string |
|
||
payment_ref |
string |
|||
payment_date |
date |
|||
billing_contact_first_name |
string |
|||
billing_contact_last_name |
string |
|||
billing_contact_email |
tuple |
membership_type¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
public_name |
string |
|||
active |
boolean |
|||
plan_type |
string |
|
||
max_linked_members |
number |
|||
description |
string |
|||
conditions |
string |
|||
payment_plans |
reference |
set |
payment_plan |
|
extras_json |
json_string |
|||
cost |
number |
|||
joining_fee |
number |
|||
currency |
string |
|
||
gocardless_paylink |
string |
|||
period |
string |
|
||
member_tags |
string |
set |
||
auto_renew |
boolean |
|||
resource_limit |
string |
set |
|
|
xero_account_code |
string |
|||
tax |
string |
|
||
first_available_date |
date |
|||
fixed_start_date |
string |
|||
fixed_end_date |
string |
|||
gift_aid |
boolean |
|||
hide_from_self_service |
boolean |
|||
lifecycle_triggers |
boolean |
turn on/off lifecycle triggers for this plan |
||
sort_order |
number |
|||
access_code |
string |
message¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
uid |
string |
|||
s3_original_message |
string |
|||
type |
string |
|
||
system_type |
string |
|
||
status |
string |
|
||
to |
string |
|||
from |
string |
|||
subject |
string |
|||
to_reference |
reference |
set |
|
|
cc_reference |
reference |
set |
|
|
delivery_status |
json_string |
|||
regarding |
reference |
|
||
group_members |
reference |
set |
|
|
from_reference |
string |
|||
raw |
string |
|||
files |
s3file |
list |
||
text_message |
string |
|||
html_message |
string |
|||
date |
date |
|||
process_date |
date |
|||
acknowledgement_date |
date |
|||
read |
boolean |
|||
requires_acknowledgement |
boolean |
|||
acknowledged |
boolean |
moment¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
date |
date |
|||
booking_ref |
reference |
|
||
session_ref |
reference |
|
||
tags |
string |
set |
organisation¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
formatted_name |
string |
|||
sortable_name |
string |
|||
trading_name |
string |
|||
summary |
string |
|||
address_lines |
string |
list |
||
locality |
string |
|||
region |
string |
|||
postal_code |
string |
|||
country |
string |
|||
iso_country |
string |
|||
geo |
tuple |
|||
telephone |
tuple |
set |
||
tuple |
set |
|||
email_opt_out |
boolean |
When true the contact will not be sent bulk emails or pushed to mailchimp |
||
automatic_email_opt_out |
boolean |
Breaker switch for Sheep generated auto emails e.g. membership renewals, booking confirmations |
||
automatic_sms_opt_out |
boolean |
Breaker switch for Sheep generated auto sms |
||
skype_username |
string |
|||
twitter_username |
string |
|||
facebook_username |
string |
|||
instagram_username |
string |
|||
linkedin_public_profile |
string |
|||
photo |
s3image |
|||
tags |
string |
set |
||
website |
string |
|||
domain_name |
string |
|||
domains |
string |
set |
||
notes |
string |
|||
member_since |
date |
|||
vat_registered |
boolean |
|||
vat_number |
string |
|||
charity_number |
string |
|||
company_number |
string |
|||
avatar |
s3image |
|||
external_photo_url |
string |
|||
source |
string |
|||
industry |
string |
|
||
sector |
string |
|||
sic_two_digit_code |
string |
|||
sic_code |
string |
|||
naics_code |
string |
|||
turnover_band |
string |
|
||
organisation_type |
string |
|
||
number_of_employees |
string |
|||
primary_service_offered |
string |
|||
services_offered |
string |
set |
||
website_description |
string |
|||
favicon |
s3image |
|||
website_image |
s3image |
|||
stripe_uid |
string |
|||
xero_uid |
string |
|||
gocardless_uid |
string |
|||
mailchimp_last_sync |
date |
|||
has_direct_debit_mandate |
boolean |
|||
member_original_join_date |
date |
|||
extras |
dict |
page¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
template |
string |
|
||
active |
boolean |
|||
public |
boolean |
|||
member_only |
boolean |
|||
title |
string |
|||
body |
string |
|||
fallback_body |
string |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
path |
string |
|||
resource_type |
string |
|
||
tags |
string |
set |
||
meta |
dict |
page_index¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
template |
string |
|
||
table_config |
string |
|
||
active |
boolean |
|||
public |
boolean |
|||
member_only |
boolean |
|||
title |
string |
|||
body |
string |
|||
fallback_body |
string |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
path |
string |
|||
resource_type |
string |
|
||
tags |
string |
set |
||
filter |
dict |
|||
meta |
dict |
|||
publish_date |
date |
|||
archive_date |
date |
|||
file |
s3file |
|||
thumbnail |
s3image |
page_news¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
template |
string |
|
||
context_ref |
reference |
set |
|
|
active |
boolean |
|||
public |
boolean |
|||
member_only |
boolean |
|||
title |
string |
|||
body |
string |
|||
fallback_body |
string |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
path |
string |
|||
tags |
string |
set |
||
publish_date |
date |
|||
archive_date |
date |
payment¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
payer_reference |
reference |
|
||
payment_plan_ref |
reference |
|
||
reference |
reference |
set |
|
|
payment_reconciled |
boolean |
|||
payment_type |
string |
|||
amount |
string |
|||
currency |
string |
|
||
amount_minus_fees |
string |
|||
payment_processor |
string |
|
||
payment_ref |
string |
|||
description |
string |
|||
locked |
boolean |
|||
donation |
boolean |
treat this payment as a donation |
||
appeal |
reference |
|
||
restricted_to |
reference |
|
||
gift_aid |
boolean |
|||
payment_date |
date |
|||
processing_fees |
string |
|||
formatted_display_value |
string |
|||
xero_invoice_ref |
string |
payment_plan¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
payment_plan_name |
string |
|||
sort_order |
number |
|||
active |
boolean |
|||
description |
string |
|||
button_cta |
string |
|||
price_summary_text |
string |
|||
number_of_payments |
number |
|||
defer_payment |
number |
|||
discount |
number |
|||
scope |
string |
|
||
period |
string |
|
||
payment_processor |
string |
|||
access_code |
string |
|||
rules |
json_string |
person¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
person_org_hybrid |
boolean |
|||
name |
string |
|||
first_name |
string |
|||
last_name |
string |
|||
initial |
string |
|||
title |
string |
|||
known_as |
string |
|||
name_suffix |
string |
|||
pronoun |
string |
|
||
editable_salutation |
string |
|||
salutation |
string |
|||
editable_formatted_name |
string |
|||
formatted_name |
string |
|||
sortable_name |
string |
|||
address_lines |
string |
list |
||
locality |
string |
|||
region |
string |
|||
postal_code |
string |
|||
mailsort_code |
string |
|||
country |
string |
|||
iso_country |
string |
|||
geo |
tuple |
|||
telephone |
tuple |
set |
||
tuple |
set |
|||
skype_username |
string |
|||
twitter_username |
string |
|||
facebook_username |
string |
|||
instagram_username |
string |
|||
linkedin_public_profile |
string |
|||
domain |
string |
|||
domains |
string |
set |
||
time_zone |
string |
|||
member_since |
date |
|||
member_original_join_date |
date |
|||
anniversary |
date |
|||
date_of_birth |
date |
|||
date_of_death |
date |
|||
adult |
boolean |
|||
deceased |
boolean |
|||
test |
boolean |
|||
gender |
string |
|
||
hide_from_views |
boolean |
|||
language |
string |
|||
expertise |
string |
|||
photo |
s3image |
|||
external_photo_url |
string |
|||
employer |
string |
|||
job_title |
string |
|||
tags |
string |
set |
||
website |
string |
|||
has_direct_debit_mandate |
boolean |
|||
abilities |
string |
set |
||
colour |
string |
|||
notes |
string |
|||
connections |
link |
set |
|
|
email_opt_out |
boolean |
When true the contact will not be sent bulk emails or pushed to mailchimp |
||
automatic_email_opt_out |
boolean |
Breaker switch for Sheep generated auto emails e.g. membership renewals, booking confirmations |
||
automatic_sms_opt_out |
boolean |
|||
comms_permission |
string |
list |
|
|
gocardless_uid |
string |
|||
stripe_uid |
string |
|||
xero_uid |
string |
|||
vend_uid |
string |
|||
mailchimp_last_sync |
date |
|||
xero_last_sync |
date |
|||
stripe_last_sync |
date |
|||
external_ids |
tuple |
list |
||
source |
string |
|||
time_zone |
string |
|||
photo_required |
string |
|
||
driving_licence |
string |
|
||
school_year |
string |
|||
school_year_modifier |
number |
|||
school |
string |
|||
sen |
boolean |
|||
authorised_pickup |
string |
|||
bio |
string |
|||
interests |
string |
set |
||
emergency_contact_details |
string |
|||
emergency_contact_details_2 |
string |
|||
vat_registered |
boolean |
|||
vat_number |
string |
|||
charity_number |
string |
|||
company_number |
string |
|||
industry |
string |
|
||
sector |
string |
|||
sic_two_digit_code |
string |
|||
sic_code |
string |
|||
naics_code |
string |
|||
turnover_band |
string |
|
||
organisation_type |
string |
|
||
number_of_employees |
string |
|||
primary_service_offered |
string |
|||
services_offered |
string |
set |
||
recurring_donation_increment |
number |
|||
recurring_donation_type |
string |
|
||
recurring_donation_next_increment_date |
date |
|||
extras |
dict |
pledge¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
donor |
reference |
|
||
amount |
number |
|||
currency |
string |
|||
date |
date |
|||
start_date |
date |
|||
end_date |
date |
|||
frequency |
string |
|
||
method |
string |
|
||
payment_reference |
string |
|||
appeal |
reference |
|
||
restricted_to |
reference |
|
||
gift_aid |
boolean |
|||
thanked |
boolean |
|||
active |
boolean |
|||
notes |
string |
|||
gc_subscription_id |
string |
|||
payment_plan |
reference |
|
processing_operation¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
active |
boolean |
|||
period |
string |
|
||
internal_reference |
string |
|||
processing_notice |
string |
|||
notice_location |
string |
|||
gdpr_legal_basis |
string |
|
provenance¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
reference |
reference |
|
||
source |
string |
|||
source_reference |
string |
|||
date |
date |
|||
fields |
string |
set |
||
user |
reference |
|
quote¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
buyer_ref |
reference |
|
||
booking_ref |
reference |
|
||
context |
reference |
|
||
purchase_order_no |
string |
|||
date |
date |
|||
buyer_name |
string |
|||
for_the_attention_of |
string |
|||
billing_contact |
reference |
|
||
id |
string |
|||
xero_invoice_ref |
string |
|||
status |
string |
|
reservation¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
active |
boolean |
|||
status |
string |
|
||
name |
string |
|||
formatted_title |
string |
|||
start_datetime |
date |
|||
end_datetime |
date |
|||
booking_ref |
reference |
set |
|
|
bookable_ref |
reference |
|
||
enquiry |
boolean |
|||
buyer_ref |
reference |
|
||
number_of_attendees |
number |
|||
pricing |
string |
|
||
currency |
string |
|
||
fee |
number |
|||
tax_rate |
number |
|||
tax |
string |
|
||
tags |
string |
set |
||
cancellation_reason |
string |
segment¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
description |
string |
|||
view_context |
string |
set |
|
|
parent_segment |
reference |
|
||
active |
boolean |
|||
rules |
dict |
|||
resource_type |
string |
|
||
system_segment |
boolean |
|||
tags |
string |
set |
||
mailchimp_sync |
boolean |
If this is a segment of contacts, syncing will create a matching segment in mailchimp |
service_type¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
active |
boolean |
|||
xero_account_code |
string |
|||
category |
string |
|||
subcategory |
string |
|||
name |
string |
|||
active |
boolean |
|||
supplier |
reference |
|
||
cost_price |
number |
|||
price |
number |
|||
currency |
string |
|
||
tax |
string |
|
||
description |
string |
|||
conditions |
string |
|||
allow_attendees |
boolean |
|||
formatted_price |
string |
sheep_event¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
entity |
reference |
|
||
context |
reference |
|
||
creator |
string |
|||
title |
string |
|||
text_body |
string |
|||
date |
date |
|||
expiry_date |
date |
|||
link |
string |
|||
entry_subtype |
string |
|||
tags |
string |
set |
sheep_form¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
form_name |
string |
|||
form_template |
reference |
|
||
context |
reference |
|
||
flow_states |
string |
list |
||
flow_config |
json_string |
|||
active |
boolean |
|||
viewer_groups |
string |
set |
||
editor_groups |
string |
set |
||
short_description |
string |
|||
description |
string |
|||
summary |
string |
|||
process_notes |
string |
|||
photo |
s3image |
|||
number_of_submissions |
number |
|||
secondary_photos |
s3file |
set |
||
tags |
string |
set |
||
review_by_date |
date |
|||
expiry_date |
date |
|||
locked |
boolean |
sku¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
parent_ref |
reference |
|
||
type_ref |
reference |
|
||
used |
boolean |
|||
allocation_ref |
reference |
|
||
reserved_until_date |
date |
|||
allocation_date |
date |
|||
available_from_date |
date |
|||
available_until_date |
date |
template¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
name |
string |
|||
subject |
string |
|||
text_template |
string |
|||
template_type |
string |
|
||
active |
boolean |
|||
locked |
boolean |
ticket¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
buyer |
reference |
|
||
activity |
reference |
|
||
venue |
reference |
|
||
booking |
reference |
|
||
reference |
reference |
|
||
date |
date |
Event date |
||
purchase_date |
date |
|||
ticket_type |
reference |
|
||
amount |
string |
the price of the ticket |
||
currency |
string |
|
||
tax_rate |
number |
|||
quantity |
string |
defaults to 1 |
||
number_of_attendees |
string |
|||
formatted_title |
string |
|||
ticket_id |
string |
Use to represent a unique ticket ID |
||
lock_ticket_id |
boolean |
|||
xero_account_code |
string |
ticket_type¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
active |
boolean |
|||
name |
string |
|||
formatted_title |
string |
|||
description |
string |
|||
tax |
string |
|
||
full_ticket_price |
string |
|||
number_of_attendees_per_ticket |
string |
|||
currency |
string |
|
||
tags |
string |
set |
||
member_only |
boolean |
|||
sort_order |
number |
|||
access_code |
string |
|||
buyer_segmentation_limits |
reference |
set |
|
|
single_use |
boolean |
single use ticket types are not available for re-use by other bookings or editable in settings |
||
xero_account_code |
string |
trigger¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
name |
string |
|||
milestone_ref |
reference |
|
||
trigger_resource_type |
string |
|
||
trigger_field |
string |
|||
trigger_type |
string |
|
||
due |
number |
|||
matches |
string |
|||
timeframe |
number |
|||
entity |
string |
|||
entity_display |
string |
|||
template_title |
string |
|||
template |
string |
|||
template_ref |
reference |
template |
||
action |
string |
|
user_group¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
user_group |
string |
|||
description |
string |
|||
scope |
dict |
|||
policy |
dict |
|||
active |
boolean |
venue¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
booking |
reference |
|
||
date |
date |
|||
end_date |
date |
|||
start_time |
string |
|||
end_time |
string |
|||
start_datetime |
date |
|||
end_datetime |
date |
|||
bookable |
reference |
set |
bookable |
|
confirmed |
boolean |
|||
hirer |
reference |
|
||
notes |
string |
|||
cancelled |
boolean |
|||
editable_formatted_title |
string |
|||
where |
reference |
bookable |
||
full_span_activity |
boolean |
|||
formatted_title |
string |
vehicle¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
legacy_uid |
string |
|||
vehicle_type |
string |
|
||
owner |
reference |
|
||
make |
string |
|||
model |
string |
|||
model_long |
string |
|||
manufacturer |
string |
|||
style |
string |
|||
colour |
string |
|||
co2_emissions |
string |
|||
fuel_type |
string |
|||
capacity |
string |
|||
length |
string |
|||
registration_number |
string |
|||
engine_number |
string |
|||
identifying_number |
string |
|||
year |
number |
|||
tax_due_date |
date |
|||
tax_status |
string |
|||
mot_date |
date |
|||
insurance_date |
date |
|||
purchase_date |
date |
|||
sale_date |
date |
|||
photo |
s3image |
|||
secondary_photos |
s3file |
set |
||
tags |
string |
set |
||
notes |
string |
|||
extras_json |
json_string |
webhook¶
Field |
Type |
Collection |
Values |
Notes |
---|---|---|---|---|
partner |
string |
|||
hook_type |
string |
|||
uid |
string |
|||
date |
date |
|||
payload |
json_string |
|||
contact_ref |
reference |
|