v2
latestOpenAPI 3.0.32026-08-07534393676.1 KBcompany
patch/api/company/update-plan/
Headers
X-Companystring
The company id to request data for
Request body
idstring uuid
namestring
abnstring
contact_emailstring email
contact_namestring
contact_numberstring
addressstring
weatherstring
timezonestring
employee_mestring
employee_typestring
employee_limitstring
sites_active_todaystring
last_messagestring
unread_messagesstring
total_unread_messagesstring
has_required_formsstring
planstring
company_plan_statusstring
joined_datestring
last4string
exp_yearstring
exp_monthstring
free_trail_daysstring
expense_emailstring
show_expense_duestring
claims_pdf_footerstring
created_atstring date-time
updated_atstring date-time
account_holder_employee_idstring uuid nullable
address_latnumber double nullable
address_longnumber double nullable
country'AU' | 'NZ' | 'US'
- AU - Australia
- NZ - New Zealand
- US - United States
state'AU-VIC' | 'AU-NSW' | 'AU-ACT' | 'AU-QLD' | 'AU-TAS' | 'AU-SA' | 'AU-NT' | 'AU-WA' | 'NZ-AUK' | 'NZ-BOP' | 'NZ-CAN' | 'NZ-GIS' | 'NZ-HKB' | 'NZ-MBH' | 'NZ-MWT' | 'NZ-NSN' | 'NZ-NTL' | 'NZ-OTA' | 'NZ-STL' | 'NZ-TAS' | 'NZ-TKI' | 'NZ-WKO' | 'NZ-WGN' | 'NZ-WTC' | 'NZ-CIT' | 'US-AK' | 'US-AL' | 'US-AR' | 'US-AZ' | 'US-CA' | 'US-CO' | 'US-CT' | 'US-DC' | 'US-DE' | 'US-FL' | 'US-GA' | 'US-HI' | 'US-IA' | 'US-ID' | 'US-IL' | 'US-IN' | 'US-KS' | 'US-KY' | 'US-LA' | 'US-MA' | 'US-MD' | 'US-ME' | 'US-MI' | 'US-MN' | 'US-MO' | 'US-MS' | 'US-MT' | 'US-NC' | 'US-ND' | 'US-NE' | 'US-NH' | 'US-NJ' | 'US-NM' | 'US-NV' | 'US-NY' | 'US-OH' | 'US-OK' | 'US-OR' | 'US-PA' | 'US-PR' | 'US-RI' | 'US-SC' | 'US-SD' | 'US-TN' | 'US-TX' | 'US-UT' | 'US-VA' | 'US-VT' | 'US-WA' | 'US-WI' | 'US-WV' | 'US-WY'
- AU-VIC - Victoria
- AU-NSW - New South Wales
- AU-ACT - Australian Capital Territory
- AU-QLD - Queensland
- AU-TAS - Tasmania
- AU-SA - South Australia
- AU-NT - Northern Territory
- AU-WA - Western Australia
- NZ-AUK - Auckland
- NZ-BOP - Bay of Plenty
- NZ-CAN - Canterbury
- NZ-GIS - Gisborne
- NZ-HKB - Hawke's Bay
- NZ-MBH - Marlborough
- NZ-MWT - Manawatu-Wanganui
- NZ-NSN - Nelson
- NZ-NTL - Northland
- NZ-OTA - Otago
- NZ-STL - Southland
- NZ-TAS - Tasman
- NZ-TKI - Taranaki
- NZ-WKO - Waikato
- NZ-WGN - Wellington
- NZ-WTC - West Coast
- NZ-CIT - Chatham Islands Territory
- US-AK - Alaska
- US-AL - Alabama
- US-AR - Arkansas
- US-AZ - Arizona
- US-CA - California
- US-CO - Colorado
- US-CT - Connecticut
- US-DC - District of Columbia
- US-DE - Delaware
- US-FL - Florida
- US-GA - Georgia
- US-HI - Hawaii
- US-IA - Iowa
- US-ID - Idaho
- US-IL - Illinois
- US-IN - Indiana
- US-KS - Kansas
- US-KY - Kentucky
- US-LA - Louisiana
- US-MA - Massachusetts
- US-MD - Maryland
- US-ME - Maine
- US-MI - Michigan
- US-MN - Minnesota
- US-MO - Missouri
- US-MS - Mississippi
- US-MT - Montana
- US-NC - North Carolina
- US-ND - North Dakota
- US-NE - Nebraska
- US-NH - New Hampshire
- US-NJ - New Jersey
- US-NM - New Mexico
- US-NV - Nevada
- US-NY - New York
- US-OH - Ohio
- US-OK - Oklahoma
- US-OR - Oregon
- US-PA - Pennsylvania
- US-PR - Puerto Rico
- US-RI - Rhode Island
- US-SC - South Carolina
- US-SD - South Dakota
- US-TN - Tennessee
- US-TX - Texas
- US-UT - Utah
- US-VA - Virginia
- US-VT - Vermont
- US-WA - Washington
- US-WI - Wisconsin
- US-WV - West Virginia
- US-WY - Wyoming
purchase_order_ref_no_countinteger
time_tracking'schedule' | 'daycards' | 'timetraka'
- schedule - schedule
- daycards - daycards
- timetraka - timetraka
use_authorizationboolean
advanced_loadingboolean
daycard_pdf'full' | 'employee'
- full - full
- employee - employee
timetraka_pdf'full' | 'employee'
- full - full
- employee - employee
timetraka_round_up_minutesinteger
use_timetraka_pre_work_lockoutboolean
use_timetraka_approvalboolean
use_daycard_approvalboolean
use_timetraka_geofenceboolean
timetraka_geofence_radiusinteger
timetraka_map_style'light' | 'dark'
- light - light
- dark - dark
timetraka_prework_notification_1h_beforeboolean
timetraka_prework_notification_15m_beforeboolean
timetraka_postwork_notification_15m_beforeboolean
timetraka_discrepancy_start_time_minsinteger
timetraka_discrepancy_end_time_minsinteger
timetraka_discrepancy_location_radiusinteger
timetraka_discrepancy_unscheduledboolean
timetraka_discrepancy_wrong_projectboolean
use_default_rdosboolean
use_default_public_holidaysboolean
allow_crew_access_to_all_projectsboolean
allow_contractor_access_to_all_projectsboolean
show_projects_on_diaryboolean
projects_on_diary'none' | 'active' | 'scheduled'
- none - none
- active - active
- scheduled - scheduled
show_receipts_on_expenses_pdfboolean
require_project_for_expenseboolean
show_expense_paidboolean
hide_completed_projects_on_scheduleboolean
show_only_active_projects_on_scheduleboolean
only_show_sent_daycardsboolean
only_allow_one_project_per_daycardboolean
only_allow_one_employee_per_daycardboolean
daycard_time_modeboolean
use_eba_weekendboolean
use_eba_weekdayboolean
eba_weekday_type'weekly' | 'daily'
- weekly - weekly
- daily - daily
summary_pdf_days7 | 14
- 7 - 7
- 14 - 14
work_week_hoursnumber double
work_daysDaysEnum[]
start_of_pay_week'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
- monday - monday
- tuesday - tuesday
- wednesday - wednesday
- thursday - thursday
- friday - friday
- saturday - saturday
- sunday - sunday
pdf_header_color'light' | 'dark'
- light - light
- dark - dark
project_summary_pdf_type'hours' | 'cost'
- hours - hours
- cost - cost
crew_summary_pdf_type'hours' | 'cost'
- hours - hours
- cost - cost
gst_multipliernumber double
exclude_gst_on_budgetsboolean
exclude_gst_on_claimsboolean
show_leave_balancesboolean
show_equipment_moduleboolean
show_diary_moduleboolean
show_incidents_moduleboolean
show_covid_moduleboolean
show_swms_moduleboolean
show_jsa_moduleboolean
show_wpa_moduleboolean
show_claims_moduleboolean
show_gantt_moduleboolean
show_clients_moduleboolean
show_daycards_moduleboolean
show_forms_moduleboolean
show_dockets_moduleboolean
show_expenses_moduleboolean
show_defects_moduleboolean
show_budgets_moduleboolean
show_leave_moduleboolean
logostring uri nullable
leave_calculated_ratenumber double
next_billing_datestring date-time nullable
current_plan_pricenumber double nullable
xero_travel_earnings_linestring uuid nullable
xero_send_timesheets_date'payment_date' | 'day_after_end'
- payment_date - payment_date
- day_after_end - day_after_end
last_xero_timesheet_sentstring date-time
last_xero_calendar_updatestring date-time
xero_annual_leave_typestring uuid nullable
xero_sick_leave_typestring uuid nullable
xero_personal_leave_typestring uuid nullable
xero_rdo_leave_typestring uuid nullable
xero_maternity_leave_typestring uuid nullable
xero_other_leave_typestring uuid nullable
last_myob_timesheet_sentstring date-time
myob_regular_hours_pay_itemstring nullable
myob_overtime_hours_pay_itemstring nullable
last_reece_invoice_fetchstring date-time
import_reece_invoices_automaticallyboolean
hear_about_usstring
weather_locationstring uuid nullable
message_channelstring uuid nullable
company_planstring uuid nullable
stripe_customerstring uuid nullable
Response
idstring uuid required
namestring
abnstring
contact_emailstring email
contact_namestring
contact_numberstring
addressstring
weatherstring required
timezonestring required
employee_mestring required
employee_typestring required
employee_limitstring required
sites_active_todaystring required
last_messagestring required
unread_messagesstring required
total_unread_messagesstring required
has_required_formsstring required
planstring required
company_plan_statusstring required
joined_datestring required
last4string required
exp_yearstring required
exp_monthstring required
free_trail_daysstring required
expense_emailstring required
show_expense_duestring
claims_pdf_footerstring required
created_atstring date-time required
updated_atstring date-time required
account_holder_employee_idstring uuid nullable
address_latnumber double nullable
address_longnumber double nullable
country'AU' | 'NZ' | 'US'
- AU - Australia
- NZ - New Zealand
- US - United States
state'AU-VIC' | 'AU-NSW' | 'AU-ACT' | 'AU-QLD' | 'AU-TAS' | 'AU-SA' | 'AU-NT' | 'AU-WA' | 'NZ-AUK' | 'NZ-BOP' | 'NZ-CAN' | 'NZ-GIS' | 'NZ-HKB' | 'NZ-MBH' | 'NZ-MWT' | 'NZ-NSN' | 'NZ-NTL' | 'NZ-OTA' | 'NZ-STL' | 'NZ-TAS' | 'NZ-TKI' | 'NZ-WKO' | 'NZ-WGN' | 'NZ-WTC' | 'NZ-CIT' | 'US-AK' | 'US-AL' | 'US-AR' | 'US-AZ' | 'US-CA' | 'US-CO' | 'US-CT' | 'US-DC' | 'US-DE' | 'US-FL' | 'US-GA' | 'US-HI' | 'US-IA' | 'US-ID' | 'US-IL' | 'US-IN' | 'US-KS' | 'US-KY' | 'US-LA' | 'US-MA' | 'US-MD' | 'US-ME' | 'US-MI' | 'US-MN' | 'US-MO' | 'US-MS' | 'US-MT' | 'US-NC' | 'US-ND' | 'US-NE' | 'US-NH' | 'US-NJ' | 'US-NM' | 'US-NV' | 'US-NY' | 'US-OH' | 'US-OK' | 'US-OR' | 'US-PA' | 'US-PR' | 'US-RI' | 'US-SC' | 'US-SD' | 'US-TN' | 'US-TX' | 'US-UT' | 'US-VA' | 'US-VT' | 'US-WA' | 'US-WI' | 'US-WV' | 'US-WY'
- AU-VIC - Victoria
- AU-NSW - New South Wales
- AU-ACT - Australian Capital Territory
- AU-QLD - Queensland
- AU-TAS - Tasmania
- AU-SA - South Australia
- AU-NT - Northern Territory
- AU-WA - Western Australia
- NZ-AUK - Auckland
- NZ-BOP - Bay of Plenty
- NZ-CAN - Canterbury
- NZ-GIS - Gisborne
- NZ-HKB - Hawke's Bay
- NZ-MBH - Marlborough
- NZ-MWT - Manawatu-Wanganui
- NZ-NSN - Nelson
- NZ-NTL - Northland
- NZ-OTA - Otago
- NZ-STL - Southland
- NZ-TAS - Tasman
- NZ-TKI - Taranaki
- NZ-WKO - Waikato
- NZ-WGN - Wellington
- NZ-WTC - West Coast
- NZ-CIT - Chatham Islands Territory
- US-AK - Alaska
- US-AL - Alabama
- US-AR - Arkansas
- US-AZ - Arizona
- US-CA - California
- US-CO - Colorado
- US-CT - Connecticut
- US-DC - District of Columbia
- US-DE - Delaware
- US-FL - Florida
- US-GA - Georgia
- US-HI - Hawaii
- US-IA - Iowa
- US-ID - Idaho
- US-IL - Illinois
- US-IN - Indiana
- US-KS - Kansas
- US-KY - Kentucky
- US-LA - Louisiana
- US-MA - Massachusetts
- US-MD - Maryland
- US-ME - Maine
- US-MI - Michigan
- US-MN - Minnesota
- US-MO - Missouri
- US-MS - Mississippi
- US-MT - Montana
- US-NC - North Carolina
- US-ND - North Dakota
- US-NE - Nebraska
- US-NH - New Hampshire
- US-NJ - New Jersey
- US-NM - New Mexico
- US-NV - Nevada
- US-NY - New York
- US-OH - Ohio
- US-OK - Oklahoma
- US-OR - Oregon
- US-PA - Pennsylvania
- US-PR - Puerto Rico
- US-RI - Rhode Island
- US-SC - South Carolina
- US-SD - South Dakota
- US-TN - Tennessee
- US-TX - Texas
- US-UT - Utah
- US-VA - Virginia
- US-VT - Vermont
- US-WA - Washington
- US-WI - Wisconsin
- US-WV - West Virginia
- US-WY - Wyoming
purchase_order_ref_no_countinteger
time_tracking'schedule' | 'daycards' | 'timetraka'
- schedule - schedule
- daycards - daycards
- timetraka - timetraka
use_authorizationboolean
advanced_loadingboolean
daycard_pdf'full' | 'employee'
- full - full
- employee - employee
timetraka_pdf'full' | 'employee'
- full - full
- employee - employee
timetraka_round_up_minutesinteger
use_timetraka_pre_work_lockoutboolean
use_timetraka_approvalboolean
use_daycard_approvalboolean
use_timetraka_geofenceboolean
timetraka_geofence_radiusinteger
timetraka_map_style'light' | 'dark'
- light - light
- dark - dark
timetraka_prework_notification_1h_beforeboolean
timetraka_prework_notification_15m_beforeboolean
timetraka_postwork_notification_15m_beforeboolean
timetraka_discrepancy_start_time_minsinteger
timetraka_discrepancy_end_time_minsinteger
timetraka_discrepancy_location_radiusinteger
timetraka_discrepancy_unscheduledboolean
timetraka_discrepancy_wrong_projectboolean
use_default_rdosboolean
use_default_public_holidaysboolean
allow_crew_access_to_all_projectsboolean
allow_contractor_access_to_all_projectsboolean
show_projects_on_diaryboolean
projects_on_diary'none' | 'active' | 'scheduled'
- none - none
- active - active
- scheduled - scheduled
show_receipts_on_expenses_pdfboolean
require_project_for_expenseboolean
show_expense_paidboolean
hide_completed_projects_on_scheduleboolean
show_only_active_projects_on_scheduleboolean
only_show_sent_daycardsboolean
only_allow_one_project_per_daycardboolean
only_allow_one_employee_per_daycardboolean
daycard_time_modeboolean
use_eba_weekendboolean
use_eba_weekdayboolean
eba_weekday_type'weekly' | 'daily'
- weekly - weekly
- daily - daily
summary_pdf_days7 | 14
- 7 - 7
- 14 - 14
work_week_hoursnumber double
work_daysDaysEnum[]
start_of_pay_week'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
- monday - monday
- tuesday - tuesday
- wednesday - wednesday
- thursday - thursday
- friday - friday
- saturday - saturday
- sunday - sunday
pdf_header_color'light' | 'dark'
- light - light
- dark - dark
project_summary_pdf_type'hours' | 'cost'
- hours - hours
- cost - cost
crew_summary_pdf_type'hours' | 'cost'
- hours - hours
- cost - cost
gst_multipliernumber double
exclude_gst_on_budgetsboolean
exclude_gst_on_claimsboolean
show_leave_balancesboolean
show_equipment_moduleboolean
show_diary_moduleboolean
show_incidents_moduleboolean
show_covid_moduleboolean
show_swms_moduleboolean
show_jsa_moduleboolean
show_wpa_moduleboolean
show_claims_moduleboolean
show_gantt_moduleboolean
show_clients_moduleboolean
show_daycards_moduleboolean
show_forms_moduleboolean
show_dockets_moduleboolean
show_expenses_moduleboolean
show_defects_moduleboolean
show_budgets_moduleboolean
show_leave_moduleboolean
logostring uri nullable
leave_calculated_ratenumber double
next_billing_datestring date-time nullable
current_plan_pricenumber double nullable
xero_travel_earnings_linestring uuid nullable
xero_send_timesheets_date'payment_date' | 'day_after_end'
- payment_date - payment_date
- day_after_end - day_after_end
last_xero_timesheet_sentstring date-time required
last_xero_calendar_updatestring date-time
xero_annual_leave_typestring uuid nullable
xero_sick_leave_typestring uuid nullable
xero_personal_leave_typestring uuid nullable
xero_rdo_leave_typestring uuid nullable
xero_maternity_leave_typestring uuid nullable
xero_other_leave_typestring uuid nullable
last_myob_timesheet_sentstring date-time required
myob_regular_hours_pay_itemstring nullable
myob_overtime_hours_pay_itemstring nullable
last_reece_invoice_fetchstring date-time
import_reece_invoices_automaticallyboolean
hear_about_usstring
weather_locationstring uuid nullable
message_channelstring uuid nullable
company_planstring uuid nullable
stripe_customerstring uuid nullable