/repairshopr-scheduling | Type: Application | PCID required: Yes
Tools
repairshopr_scheduling_create_appointment_types
Creates an Appointment Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_instructions | string | No | — | Email Instructions |
location_hard_code | string | No | — | Location Hard Code |
location_type | integer | No | — | Location Type |
name | string | Yes | — | The name value |
repairshopr_scheduling_create_appointments
Creates an Appointment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
all_day | boolean | No | — | All Day |
appointment_duration | string | No | — | Appointment Duration |
appointment_type_id | integer | No | — | Appointment Type Id |
customer_id | integer | No | — | Customer Id |
description | string | No | — | The description value |
do_not_email | boolean | No | — | Do Not Email |
email_customer | boolean | No | — | Email Customer |
end_at | string | No | — | End At |
location | string | No | — | The location value |
start_at | string | Yes | — | Start At |
summary | string | Yes | — | The summary value |
ticket_id | integer | No | — | Ticket Id |
user_id | integer | No | — | User Id |
user_ids | integer[] | No | — | User Ids |
repairshopr_scheduling_create_contracts
Creates a Contract Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apply_to_all | boolean | No | — | Apply To All |
contract_amount | string | No | — | Contract Amount |
customer_id | integer | Yes | — | Customer Id |
description | string | No | — | The description value |
end_date | string | No | — | End date for filtering |
likelihood | integer | No | — | The likelihood value |
name | string | No | — | The name value |
primary_contact | string | No | — | Primary Contact |
sla_id | integer | No | — | Sla Id |
start_date | string | No | — | Start date for filtering |
status | string | No | — | The status value |
repairshopr_scheduling_create_schedules
Creates an Invoice Schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
charge_mop | boolean | No | — | Charge Mop |
customer_id | integer | No | — | Customer Id |
email_customer | boolean | No | — | Email Customer |
frequency | string | No | — | The frequency value |
invoice_unbilled_ticket_charges | boolean | No | — | Invoice Unbilled Ticket Charges |
name | string | No | — | The name value |
next_run | string | No | — | Next Run |
paused | boolean | No | — | The paused value |
snail_mail | boolean | No | — | Snail Mail |
repairshopr_scheduling_create_schedules_by_id_add_line_item
Adds a Line Item to an Invoice Schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
asset_type_id | integer | No | — | Asset Type Id |
contact_field_answer_id | integer | No | — | Contact Field Answer Id |
contact_field_type_id | integer | No | — | Contact Field Type Id |
cost_cents | integer | No | — | Cost Cents |
description | string | No | — | The description value |
name | string | No | — | The name value |
one_time_charge | boolean | No | — | One Time Charge |
position | integer | No | — | The position value |
product_id | integer | No | — | Product Id |
quantity | number | No | — | The quantity value |
recurring_type_id | integer | No | — | Recurring Type Id |
retail_cents | integer | No | — | Retail Cents |
saved_asset_search_id | integer | No | — | Saved Asset Search Id |
taxable | boolean | No | — | The taxable value |
user_id | integer | No | — | User Id |
repairshopr_scheduling_create_schedules_by_id_remove_line_item
Removes a Line Item from an Invoice Schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
line_item_id | integer | Yes | — | ID of the line item to remove |
repairshopr_scheduling_delete_appointment_types_by_id
Deletes an Appointment Type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_delete_appointments_by_id
Deletes an Appointment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_delete_contracts_by_id
Deletes a Contract by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_delete_schedules_by_id
Deletes a Schedule by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_get_appointment_types_by_id
Retrieves an Appointment Type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_get_appointments_by_id
Retrieves an Appointment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_get_contracts_by_id
Retrieves a Contract by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_get_schedules_by_id
Retrieves a Schedule by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_scheduling_list_appointment_types
Returns a paginated list of Appointment Typesrepairshopr_scheduling_list_appointments
Returns a paginated list of Appointments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_from | string | No | — | Returns Appointments that start after the date. Example “2019-01-25” |
date_to | string | No | — | Returns Appointments that start before the date. Example “2019-12-31” |
mine | boolean | No | — | Return only current user’s appointments |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
repairshopr_scheduling_list_contracts
Returns a paginated list of Contracts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Returns provided page of results, each ‘page’ contains 50 results |
repairshopr_scheduling_list_schedules
Returns a paginated list of Invoice Schedules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | No | — | Returns a list of Schedules that belong to a Customer ID |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
repairshopr_scheduling_list_timelogs
Returns a paginated list of Timelogs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | No | — | Returns Timelogs that belong to a User |
repairshopr_scheduling_list_timelogs_last
Returns last Timelog Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | No | — | Returns 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
email_instructions | string | No | — | Email Instructions |
location_hard_code | string | No | — | Location Hard Code |
location_type | integer | No | — | Location Type |
name | string | No | — | The name value |
repairshopr_scheduling_update_appointments_by_id
Updates an existing Appointment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
all_day | boolean | No | — | All Day |
appointment_duration | string | No | — | Appointment Duration |
appointment_type_id | integer | No | — | Appointment Type Id |
customer_id | integer | No | — | Customer Id |
description | string | No | — | The description value |
email_customer | boolean | No | — | Email Customer |
end_at | string | No | — | End At |
location | string | No | — | The location value |
start_at | string | Yes | — | Start At |
summary | string | No | — | The summary value |
ticket_id | integer | No | — | Ticket Id |
user_id | integer | No | — | User Id |
user_ids | integer[] | No | — | User Ids |
repairshopr_scheduling_update_contracts_by_id
Updates an existing Contract by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
apply_to_all | boolean | No | — | Apply To All |
contract_amount | string | No | — | Contract Amount |
customer_id | integer | Yes | — | Customer Id |
description | string | No | — | The description value |
end_date | string | No | — | End date for filtering |
likelihood | integer | No | — | The likelihood value |
name | string | No | — | The name value |
primary_contact | string | No | — | Primary Contact |
sla_id | integer | No | — | Sla Id |
start_date | string | No | — | Start date for filtering |
status | string | No | — | The status value |
repairshopr_scheduling_update_schedules_by_id
Updates an existing Invoice Schedule by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
charge_mop | boolean | No | — | Charge Mop |
customer_id | integer | No | — | Customer Id |
email_customer | boolean | No | — | Email Customer |
frequency | string | No | — | The frequency value |
invoice_unbilled_ticket_charges | boolean | No | — | Invoice Unbilled Ticket Charges |
name | string | No | — | The name value |
next_run | string | No | — | Next Run |
paused | boolean | No | — | The paused value |
snail_mail | boolean | No | — | Snail Mail |
repairshopr_scheduling_update_schedules_by_id_line_items_by_schedule_line_item_id
Updates a Line Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
schedule_line_item_id | integer | Yes | — | ID of line item to update |
asset_type_id | integer | No | — | Asset Type Id |
contact_field_answer_id | integer | No | — | Contact Field Answer Id |
contact_field_type_id | integer | No | — | Contact Field Type Id |
cost_cents | integer | No | — | Cost Cents |
description | string | No | — | The description value |
name | string | No | — | The name value |
one_time_charge | boolean | No | — | One Time Charge |
position | integer | No | — | The position value |
product_id | integer | No | — | Product Id |
quantity | number | No | — | The quantity value |
recurring_type_id | integer | No | — | Recurring Type Id |
retail_cents | integer | No | — | Retail Cents |
saved_asset_search_id | integer | No | — | Saved Asset Search Id |
taxable | boolean | No | — | The taxable value |
user_id | integer | No | — | User Id |
repairshopr_scheduling_update_timelogs
Updates a Timelog Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
in_at | string | No | — | In At |
in_note | string | No | — | In Note |
lunch | boolean | No | — | The lunch value |
out_at | string | No | — | Out At |
out_note | string | No | — | Out Note |

