Skip to main content
Server path: /repairshopr-scheduling | Type: Application | PCID required: Yes

Tools

ToolDescription
repairshopr_scheduling_create_appointment_typesCreates an Appointment Type
repairshopr_scheduling_create_appointmentsCreates an Appointment
repairshopr_scheduling_create_contractsCreates a Contract
repairshopr_scheduling_create_schedulesCreates an Invoice Schedule
repairshopr_scheduling_create_schedules_by_id_add_line_itemAdds a Line Item to an Invoice Schedule
repairshopr_scheduling_create_schedules_by_id_remove_line_itemRemoves a Line Item from an Invoice Schedule
repairshopr_scheduling_delete_appointment_types_by_idDeletes an Appointment Type by ID
repairshopr_scheduling_delete_appointments_by_idDeletes an Appointment by ID
repairshopr_scheduling_delete_contracts_by_idDeletes a Contract by ID
repairshopr_scheduling_delete_schedules_by_idDeletes a Schedule by ID
repairshopr_scheduling_get_appointment_types_by_idRetrieves an Appointment Type by ID
repairshopr_scheduling_get_appointments_by_idRetrieves an Appointment by ID
repairshopr_scheduling_get_contracts_by_idRetrieves a Contract by ID
repairshopr_scheduling_get_schedules_by_idRetrieves a Schedule by ID
repairshopr_scheduling_list_appointment_typesReturns a paginated list of Appointment Types
repairshopr_scheduling_list_appointmentsReturns a paginated list of Appointments
repairshopr_scheduling_list_contractsReturns a paginated list of Contracts
repairshopr_scheduling_list_schedulesReturns a paginated list of Invoice Schedules
repairshopr_scheduling_list_timelogsReturns a paginated list of Timelogs
repairshopr_scheduling_list_timelogs_lastReturns last Timelog
repairshopr_scheduling_update_appointment_types_by_idUpdates an existing Appointment Type by ID
repairshopr_scheduling_update_appointments_by_idUpdates an existing Appointment by ID
repairshopr_scheduling_update_contracts_by_idUpdates an existing Contract by ID
repairshopr_scheduling_update_schedules_by_idUpdates an existing Invoice Schedule by ID
repairshopr_scheduling_update_schedules_by_id_line_items_by_schedule_line_item_idUpdates a Line Item
repairshopr_scheduling_update_timelogsUpdates a Timelog

repairshopr_scheduling_create_appointment_types

Creates an Appointment Type Parameters:
ParameterTypeRequiredDefaultDescription
email_instructionsstringNoEmail Instructions
location_hard_codestringNoLocation Hard Code
location_typeintegerNoLocation Type
namestringYesThe name value

repairshopr_scheduling_create_appointments

Creates an Appointment Parameters:
ParameterTypeRequiredDefaultDescription
all_daybooleanNoAll Day
appointment_durationstringNoAppointment Duration
appointment_type_idintegerNoAppointment Type Id
customer_idintegerNoCustomer Id
descriptionstringNoThe description value
do_not_emailbooleanNoDo Not Email
email_customerbooleanNoEmail Customer
end_atstringNoEnd At
locationstringNoThe location value
start_atstringYesStart At
summarystringYesThe summary value
ticket_idintegerNoTicket Id
user_idintegerNoUser Id
user_idsinteger[]NoUser Ids

repairshopr_scheduling_create_contracts

Creates a Contract Parameters:
ParameterTypeRequiredDefaultDescription
apply_to_allbooleanNoApply To All
contract_amountstringNoContract Amount
customer_idintegerYesCustomer Id
descriptionstringNoThe description value
end_datestringNoEnd date for filtering
likelihoodintegerNoThe likelihood value
namestringNoThe name value
primary_contactstringNoPrimary Contact
sla_idintegerNoSla Id
start_datestringNoStart date for filtering
statusstringNoThe status value

repairshopr_scheduling_create_schedules

Creates an Invoice Schedule Parameters:
ParameterTypeRequiredDefaultDescription
charge_mopbooleanNoCharge Mop
customer_idintegerNoCustomer Id
email_customerbooleanNoEmail Customer
frequencystringNoThe frequency value
invoice_unbilled_ticket_chargesbooleanNoInvoice Unbilled Ticket Charges
namestringNoThe name value
next_runstringNoNext Run
pausedbooleanNoThe paused value
snail_mailbooleanNoSnail Mail

repairshopr_scheduling_create_schedules_by_id_add_line_item

Adds a Line Item to an Invoice Schedule Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
asset_type_idintegerNoAsset Type Id
contact_field_answer_idintegerNoContact Field Answer Id
contact_field_type_idintegerNoContact Field Type Id
cost_centsintegerNoCost Cents
descriptionstringNoThe description value
namestringNoThe name value
one_time_chargebooleanNoOne Time Charge
positionintegerNoThe position value
product_idintegerNoProduct Id
quantitynumberNoThe quantity value
recurring_type_idintegerNoRecurring Type Id
retail_centsintegerNoRetail Cents
saved_asset_search_idintegerNoSaved Asset Search Id
taxablebooleanNoThe taxable value
user_idintegerNoUser Id

repairshopr_scheduling_create_schedules_by_id_remove_line_item

Removes a Line Item from an Invoice Schedule Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
line_item_idintegerYesID of the line item to remove

repairshopr_scheduling_delete_appointment_types_by_id

Deletes an Appointment Type by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_delete_appointments_by_id

Deletes an Appointment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_delete_contracts_by_id

Deletes a Contract by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_delete_schedules_by_id

Deletes a Schedule by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_get_appointment_types_by_id

Retrieves an Appointment Type by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_get_appointments_by_id

Retrieves an Appointment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_get_contracts_by_id

Retrieves a Contract by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_get_schedules_by_id

Retrieves a Schedule by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_scheduling_list_appointment_types

Returns a paginated list of Appointment Types

repairshopr_scheduling_list_appointments

Returns a paginated list of Appointments Parameters:
ParameterTypeRequiredDefaultDescription
date_fromstringNoReturns Appointments that start after the date. Example “2019-01-25”
date_tostringNoReturns Appointments that start before the date. Example “2019-12-31”
minebooleanNoReturn only current user’s appointments
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_scheduling_list_contracts

Returns a paginated list of Contracts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoReturns provided page of results, each ‘page’ contains 50 results

repairshopr_scheduling_list_schedules

Returns a paginated list of Invoice Schedules Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerNoReturns a list of Schedules that belong to a Customer ID
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_scheduling_list_timelogs

Returns a paginated list of Timelogs Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerNoReturns Timelogs that belong to a User

repairshopr_scheduling_list_timelogs_last

Returns last Timelog Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerNoReturns Timelogs that belong to a User. The default is current user ID.

repairshopr_scheduling_update_appointment_types_by_id

Updates an existing Appointment Type by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
email_instructionsstringNoEmail Instructions
location_hard_codestringNoLocation Hard Code
location_typeintegerNoLocation Type
namestringNoThe name value

repairshopr_scheduling_update_appointments_by_id

Updates an existing Appointment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
all_daybooleanNoAll Day
appointment_durationstringNoAppointment Duration
appointment_type_idintegerNoAppointment Type Id
customer_idintegerNoCustomer Id
descriptionstringNoThe description value
email_customerbooleanNoEmail Customer
end_atstringNoEnd At
locationstringNoThe location value
start_atstringYesStart At
summarystringNoThe summary value
ticket_idintegerNoTicket Id
user_idintegerNoUser Id
user_idsinteger[]NoUser Ids

repairshopr_scheduling_update_contracts_by_id

Updates an existing Contract by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
apply_to_allbooleanNoApply To All
contract_amountstringNoContract Amount
customer_idintegerYesCustomer Id
descriptionstringNoThe description value
end_datestringNoEnd date for filtering
likelihoodintegerNoThe likelihood value
namestringNoThe name value
primary_contactstringNoPrimary Contact
sla_idintegerNoSla Id
start_datestringNoStart date for filtering
statusstringNoThe status value

repairshopr_scheduling_update_schedules_by_id

Updates an existing Invoice Schedule by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
charge_mopbooleanNoCharge Mop
customer_idintegerNoCustomer Id
email_customerbooleanNoEmail Customer
frequencystringNoThe frequency value
invoice_unbilled_ticket_chargesbooleanNoInvoice Unbilled Ticket Charges
namestringNoThe name value
next_runstringNoNext Run
pausedbooleanNoThe paused value
snail_mailbooleanNoSnail Mail

repairshopr_scheduling_update_schedules_by_id_line_items_by_schedule_line_item_id

Updates a Line Item Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
schedule_line_item_idintegerYesID of line item to update
asset_type_idintegerNoAsset Type Id
contact_field_answer_idintegerNoContact Field Answer Id
contact_field_type_idintegerNoContact Field Type Id
cost_centsintegerNoCost Cents
descriptionstringNoThe description value
namestringNoThe name value
one_time_chargebooleanNoOne Time Charge
positionintegerNoThe position value
product_idintegerNoProduct Id
quantitynumberNoThe quantity value
recurring_type_idintegerNoRecurring Type Id
retail_centsintegerNoRetail Cents
saved_asset_search_idintegerNoSaved Asset Search Id
taxablebooleanNoThe taxable value
user_idintegerNoUser Id

repairshopr_scheduling_update_timelogs

Updates a Timelog Parameters:
ParameterTypeRequiredDefaultDescription
in_atstringNoIn At
in_notestringNoIn Note
lunchbooleanNoThe lunch value
out_atstringNoOut At
out_notestringNoOut Note