/repairshopr-billing | Type: Application | PCID required: Yes
Tools
repairshopr_billing_create_customers_by_customer_id_payment_profiles
Creates a Payment Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | Yes | — | Customer Id |
customer_external_id | string | No | — | Payment Gateway’s Customer token |
expiration | string | No | — | The expiration value |
last_four | string | No | — | Last Four |
payment_profile_id | string | No | — | Payment Gateway’s stored payment profile token |
repairshopr_billing_create_estimates
Creates an Estimate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | Created At |
customer_id | integer | No | — | Customer Id |
date | string | No | — | The date value |
line_items | object[] | No | — | Array of Line Items. |
location_id | integer | No | — | Location Id |
name | string | No | — | The name value |
note | string | No | — | The note value |
number | string | No | — | The number value |
status | string | No | — | Valid values are Fresh, Draft, Approved, Declined. |
ticket_id | integer | No | — | Ticket Id |
updated_at | string | No | — | Updated At |
repairshopr_billing_create_estimates_by_id_convert_to_invoice
Convert an Estimate to an Invoice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_billing_create_estimates_by_id_email
Sends an Estimate to a Customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_billing_create_estimates_by_id_line_items
Adds a Line Item to an Estimate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
cost | number | No | — | The cost value |
discount_percent | number | No | — | Discount Percent |
item | string | No | — | The item value |
name | string | No | — | The name value |
position | integer | No | — | The position value |
price | number | No | — | The price value |
product_category | string | No | — | Product Category |
product_id | integer | No | — | Product Id |
quantity | number | No | — | The quantity value |
tax_note | string | No | — | Tax Note |
tax_rate_id | integer | No | — | Tax Rate Id |
taxable | boolean | No | — | The taxable value |
upc_code | string | No | — | Upc Code |
user_id | integer | No | — | User Id |
repairshopr_billing_create_estimates_by_id_print
Queues a print job for an Estimate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_billing_create_invoices
Creates an Invoice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | integer | No | — | Contact Id |
created_at | string | No | — | Created At |
customer_id | integer | Yes | — | Customer Id |
date | string | Yes | — | The date value |
due_date | string | No | — | Due Date |
hardwarecost | number | No | — | The hardwarecost value |
line_items | object[] | No | — | Line Items |
location_id | integer | No | — | Location Id |
note | string | No | — | The note value |
number | string | Yes | — | The number value |
po_number | string | No | — | Po Number |
ticket_id | integer | No | — | Ticket Id |
updated_at | string | No | — | Updated At |
repairshopr_billing_create_invoices_by_id_email
Sends invoice to customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice which will be emailed |
repairshopr_billing_create_invoices_by_id_line_items
Creates a new line item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice to update |
cost | number | No | — | The cost value |
discount_dollars | string | No | — | Discount Dollars |
item | string | No | — | The item value |
line_discount_percent | integer | No | — | Line Discount Percent |
name | string | No | — | The name value |
price | number | No | — | The price value |
taxable | boolean | No | — | The taxable value |
repairshopr_billing_create_invoices_by_id_print
Queues a print job for an invoice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the Invoice to print |
repairshopr_billing_create_payments
Creates a Payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address_city | string | No | — | Address City |
address_street | string | No | — | Address Street |
address_zip | string | No | — | Address Zip |
amount_cents | integer | No | — | Amount Cents |
apply_payments | object | No | — | Object where a key is an Invoice ID and a value is a payment amount to be applied to the invoice. |
customer_id | integer | No | — | Customer Id |
date_month | string | No | — | Date Month |
date_year | string | No | — | Date Year |
firstname | string | No | — | The firstname value |
invoice_id | integer | No | — | Invoice Id |
invoice_number | string | No | — | Invoice Number |
lastname | string | No | — | The lastname value |
payment_method | string | No | — | Payment Method |
ref_num | string | No | — | Ref Num |
register_id | integer | No | — | Register Id |
signature_data | string | No | — | Signature Data |
signature_date | string | No | — | Signature Date |
signature_name | string | No | — | Signature Name |
repairshopr_billing_delete_customers_by_customer_id_payment_profiles_by_id
Deletes a Payment Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | Yes | — | Customer Id |
id | integer | Yes | — | The id value |
repairshopr_billing_delete_estimates_by_id
Deletes an Estimate by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_billing_delete_estimates_by_id_line_items_by_line_item_id
Deletes a Line Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
line_item_id | integer | Yes | — | Line Item Id |
repairshopr_billing_delete_invoices_by_id
Deletes an invoice by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice to delete |
repairshopr_billing_delete_invoices_by_id_line_items_by_line_item_id
Deletes an a line item of an invoice by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice to delete |
line_item_id | integer | Yes | — | ID of line item to update |
repairshopr_billing_get_customers_by_customer_id_payment_profiles
Returns a paginated list of Payment Profiles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | Yes | — | Customer Id |
repairshopr_billing_get_customers_by_customer_id_payment_profiles_by_id
Retrieves a Payment Profile by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | Yes | — | Customer Id |
id | integer | Yes | — | The id value |
repairshopr_billing_get_estimates_by_id
Retrieves an Estimate by ID or number Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Estimate ID |
number | string | No | — | Estimate number is used when the server cannot find an Estimate by ID |
repairshopr_billing_get_invoices_by_id
Retrieves an Invoice by ID or Number Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID or Number of Invoice to retrieve |
repairshopr_billing_get_invoices_by_id_ticket
Returns the associated ticket for an invoice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice whose Ticket will be returned |
repairshopr_billing_get_payments_by_id
Retrieves a Payment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
repairshopr_billing_list_estimates
Returns a paginated list of Estimates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mine | boolean | No | — | Returns estimates that belong to the current user |
status | string | No | — | Returns estimates with a given status. Possible values are ‘approved’ and ‘declined’. |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 50 results |
repairshopr_billing_list_invoices
Returns a paginated list of Invoices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
paid | boolean | No | — | Whether or not the returned list of invoices has been marked as paid |
unpaid | boolean | No | — | Whether or not the returned list of invoices has been marked as unpaid |
ticket_id | integer | No | — | Any invoices attached to a Ticket ID |
since_updated_at | string | No | — | Any invoices updated since a date |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
repairshopr_billing_list_line_items
Returns a paginated list of Line Items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
invoice_id | integer | No | — | Returns Line Items that belong to an Invoice ID |
estimate_id | integer | No | — | Returns Line Items that belong to an Estimate ID |
invoice_id_not_null | boolean | No | — | Returns Line Items that belong to any Invoice |
estimate_id_not_null | boolean | No | — | Returns Line Items that belong to any Estimate |
repairshopr_billing_list_payment_methods
Returns a paginated list of Payment Methodsrepairshopr_billing_list_payments
Returns a paginated list of Payments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Search query |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
repairshopr_billing_update_customers_by_customer_id_payment_profiles_by_id
Updates a Payment Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | integer | Yes | — | Customer Id |
id | integer | Yes | — | The id value |
expiration | string | No | — | The expiration value |
last_four | string | No | — | Last Four |
repairshopr_billing_update_estimates_by_id
Updates an existing Estimate by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
customer_id | integer | No | — | Customer Id |
date | string | No | — | The date value |
location_id | integer | No | — | Location Id |
name | string | No | — | The name value |
note | string | No | — | The note value |
number | string | No | — | The number value |
status | string | No | — | Valid values are Fresh, Draft, Approved, Declined. |
ticket_id | integer | No | — | Ticket Id |
repairshopr_billing_update_estimates_by_id_line_items_by_line_item_id
Updates a Line Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The id value |
line_item_id | integer | Yes | — | Line Item Id |
cost | number | No | — | The cost value |
discount_percent | number | No | — | Discount Percent |
item | string | No | — | The item value |
name | string | No | — | The name value |
position | integer | No | — | The position value |
price | number | No | — | The price value |
product_category | string | No | — | Product Category |
product_id | integer | No | — | Product Id |
quantity | number | No | — | The quantity value |
tax_note | string | No | — | Tax Note |
tax_rate_id | integer | No | — | Tax Rate Id |
taxable | boolean | No | — | The taxable value |
upc_code | string | No | — | Upc Code |
user_id | integer | No | — | User Id |
repairshopr_billing_update_invoices_by_id
Updates an existing invoice by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice to update |
contact_id | integer | No | — | Contact Id |
created_at | string | No | — | Created At |
customer_id | integer | No | — | Customer Id |
date | string | No | — | The date value |
due_date | string | No | — | Due Date |
hardwarecost | number | No | — | The hardwarecost value |
location_id | integer | No | — | Location Id |
note | string | No | — | The note value |
number | string | No | — | The number value |
po_number | string | No | — | Po Number |
ticket_id | integer | No | — | Ticket Id |
updated_at | string | No | — | Updated At |
repairshopr_billing_update_invoices_by_id_line_items_by_line_item_id
Updates an a line item of an invoice by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of Invoice to update |
line_item_id | integer | Yes | — | ID of line item to update |
cost | number | No | — | The cost value |
discount_dollars | string | No | — | Discount Dollars |
item | string | No | — | The item value |
line_discount_percent | integer | No | — | Line Discount Percent |
name | string | No | — | The name value |
price | number | No | — | The price value |
taxable | boolean | No | — | The taxable value |

