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

Tools

ToolDescription
repairshopr_billing_create_customers_by_customer_id_payment_profilesCreates a Payment Profile
repairshopr_billing_create_estimatesCreates an Estimate
repairshopr_billing_create_estimates_by_id_convert_to_invoiceConvert an Estimate to an Invoice
repairshopr_billing_create_estimates_by_id_emailSends an Estimate to a Customer
repairshopr_billing_create_estimates_by_id_line_itemsAdds a Line Item to an Estimate
repairshopr_billing_create_estimates_by_id_printQueues a print job for an Estimate
repairshopr_billing_create_invoicesCreates an Invoice
repairshopr_billing_create_invoices_by_id_emailSends invoice to customer
repairshopr_billing_create_invoices_by_id_line_itemsCreates a new line item
repairshopr_billing_create_invoices_by_id_printQueues a print job for an invoice
repairshopr_billing_create_paymentsCreates a Payment
repairshopr_billing_delete_customers_by_customer_id_payment_profiles_by_idDeletes a Payment Profile
repairshopr_billing_delete_estimates_by_idDeletes an Estimate by ID
repairshopr_billing_delete_estimates_by_id_line_items_by_line_item_idDeletes a Line Item
repairshopr_billing_delete_invoices_by_idDeletes an invoice by ID
repairshopr_billing_delete_invoices_by_id_line_items_by_line_item_idDeletes an a line item of an invoice by ID
repairshopr_billing_get_customers_by_customer_id_payment_profilesReturns a paginated list of Payment Profiles
repairshopr_billing_get_customers_by_customer_id_payment_profiles_by_idRetrieves a Payment Profile by ID
repairshopr_billing_get_estimates_by_idRetrieves an Estimate by ID or number
repairshopr_billing_get_invoices_by_idRetrieves an Invoice by ID or Number
repairshopr_billing_get_invoices_by_id_ticketReturns the associated ticket for an invoice
repairshopr_billing_get_payments_by_idRetrieves a Payment by ID
repairshopr_billing_list_estimatesReturns a paginated list of Estimates
repairshopr_billing_list_invoicesReturns a paginated list of Invoices
repairshopr_billing_list_line_itemsReturns a paginated list of Line Items
repairshopr_billing_list_payment_methodsReturns a paginated list of Payment Methods
repairshopr_billing_list_paymentsReturns a paginated list of Payments
repairshopr_billing_update_customers_by_customer_id_payment_profiles_by_idUpdates a Payment Profile
repairshopr_billing_update_estimates_by_idUpdates an existing Estimate by ID
repairshopr_billing_update_estimates_by_id_line_items_by_line_item_idUpdates a Line Item
repairshopr_billing_update_invoices_by_idUpdates an existing invoice by ID
repairshopr_billing_update_invoices_by_id_line_items_by_line_item_idUpdates an a line item of an invoice by ID

repairshopr_billing_create_customers_by_customer_id_payment_profiles

Creates a Payment Profile Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYesCustomer Id
customer_external_idstringNoPayment Gateway’s Customer token
expirationstringNoThe expiration value
last_fourstringNoLast Four
payment_profile_idstringNoPayment Gateway’s stored payment profile token

repairshopr_billing_create_estimates

Creates an Estimate Parameters:
ParameterTypeRequiredDefaultDescription
created_atstringNoCreated At
customer_idintegerNoCustomer Id
datestringNoThe date value
line_itemsobject[]NoArray of Line Items.
location_idintegerNoLocation Id
namestringNoThe name value
notestringNoThe note value
numberstringNoThe number value
statusstringNoValid values are Fresh, Draft, Approved, Declined.
ticket_idintegerNoTicket Id
updated_atstringNoUpdated At

repairshopr_billing_create_estimates_by_id_convert_to_invoice

Convert an Estimate to an Invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_billing_create_estimates_by_id_email

Sends an Estimate to a Customer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_billing_create_estimates_by_id_line_items

Adds a Line Item to an Estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
costnumberNoThe cost value
discount_percentnumberNoDiscount Percent
itemstringNoThe item value
namestringNoThe name value
positionintegerNoThe position value
pricenumberNoThe price value
product_categorystringNoProduct Category
product_idintegerNoProduct Id
quantitynumberNoThe quantity value
tax_notestringNoTax Note
tax_rate_idintegerNoTax Rate Id
taxablebooleanNoThe taxable value
upc_codestringNoUpc Code
user_idintegerNoUser Id

repairshopr_billing_create_estimates_by_id_print

Queues a print job for an Estimate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_billing_create_invoices

Creates an Invoice Parameters:
ParameterTypeRequiredDefaultDescription
contact_idintegerNoContact Id
created_atstringNoCreated At
customer_idintegerYesCustomer Id
datestringYesThe date value
due_datestringNoDue Date
hardwarecostnumberNoThe hardwarecost value
line_itemsobject[]NoLine Items
location_idintegerNoLocation Id
notestringNoThe note value
numberstringYesThe number value
po_numberstringNoPo Number
ticket_idintegerNoTicket Id
updated_atstringNoUpdated At

repairshopr_billing_create_invoices_by_id_email

Sends invoice to customer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice which will be emailed

repairshopr_billing_create_invoices_by_id_line_items

Creates a new line item Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice to update
costnumberNoThe cost value
discount_dollarsstringNoDiscount Dollars
itemstringNoThe item value
line_discount_percentintegerNoLine Discount Percent
namestringNoThe name value
pricenumberNoThe price value
taxablebooleanNoThe taxable value

repairshopr_billing_create_invoices_by_id_print

Queues a print job for an invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the Invoice to print

repairshopr_billing_create_payments

Creates a Payment Parameters:
ParameterTypeRequiredDefaultDescription
address_citystringNoAddress City
address_streetstringNoAddress Street
address_zipstringNoAddress Zip
amount_centsintegerNoAmount Cents
apply_paymentsobjectNoObject where a key is an Invoice ID and a value is a payment amount to be applied to the invoice.
customer_idintegerNoCustomer Id
date_monthstringNoDate Month
date_yearstringNoDate Year
firstnamestringNoThe firstname value
invoice_idintegerNoInvoice Id
invoice_numberstringNoInvoice Number
lastnamestringNoThe lastname value
payment_methodstringNoPayment Method
ref_numstringNoRef Num
register_idintegerNoRegister Id
signature_datastringNoSignature Data
signature_datestringNoSignature Date
signature_namestringNoSignature Name

repairshopr_billing_delete_customers_by_customer_id_payment_profiles_by_id

Deletes a Payment Profile Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYesCustomer Id
idintegerYesThe id value

repairshopr_billing_delete_estimates_by_id

Deletes an Estimate by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_billing_delete_estimates_by_id_line_items_by_line_item_id

Deletes a Line Item Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
line_item_idintegerYesLine Item Id

repairshopr_billing_delete_invoices_by_id

Deletes an invoice by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice to delete
line_item_idintegerYesID of line item to update

repairshopr_billing_get_customers_by_customer_id_payment_profiles

Returns a paginated list of Payment Profiles Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYesCustomer Id

repairshopr_billing_get_customers_by_customer_id_payment_profiles_by_id

Retrieves a Payment Profile by ID Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYesCustomer Id
idintegerYesThe id value

repairshopr_billing_get_estimates_by_id

Retrieves an Estimate by ID or number Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesEstimate ID
numberstringNoEstimate 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:
ParameterTypeRequiredDefaultDescription
idintegerYesID or Number of Invoice to retrieve

repairshopr_billing_get_invoices_by_id_ticket

Returns the associated ticket for an invoice Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice whose Ticket will be returned

repairshopr_billing_get_payments_by_id

Retrieves a Payment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_billing_list_estimates

Returns a paginated list of Estimates Parameters:
ParameterTypeRequiredDefaultDescription
minebooleanNoReturns estimates that belong to the current user
statusstringNoReturns estimates with a given status. Possible values are ‘approved’ and ‘declined’.
pageintegerNoReturns provided page of results, each ‘page’ contains 50 results

repairshopr_billing_list_invoices

Returns a paginated list of Invoices Parameters:
ParameterTypeRequiredDefaultDescription
paidbooleanNoWhether or not the returned list of invoices has been marked as paid
unpaidbooleanNoWhether or not the returned list of invoices has been marked as unpaid
ticket_idintegerNoAny invoices attached to a Ticket ID
since_updated_atstringNoAny invoices updated since a date
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_billing_list_line_items

Returns a paginated list of Line Items Parameters:
ParameterTypeRequiredDefaultDescription
invoice_idintegerNoReturns Line Items that belong to an Invoice ID
estimate_idintegerNoReturns Line Items that belong to an Estimate ID
invoice_id_not_nullbooleanNoReturns Line Items that belong to any Invoice
estimate_id_not_nullbooleanNoReturns Line Items that belong to any Estimate

repairshopr_billing_list_payment_methods

Returns a paginated list of Payment Methods

repairshopr_billing_list_payments

Returns a paginated list of Payments Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query
pageintegerNoReturns 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:
ParameterTypeRequiredDefaultDescription
customer_idintegerYesCustomer Id
idintegerYesThe id value
expirationstringNoThe expiration value
last_fourstringNoLast Four

repairshopr_billing_update_estimates_by_id

Updates an existing Estimate by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
customer_idintegerNoCustomer Id
datestringNoThe date value
location_idintegerNoLocation Id
namestringNoThe name value
notestringNoThe note value
numberstringNoThe number value
statusstringNoValid values are Fresh, Draft, Approved, Declined.
ticket_idintegerNoTicket Id

repairshopr_billing_update_estimates_by_id_line_items_by_line_item_id

Updates a Line Item Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
line_item_idintegerYesLine Item Id
costnumberNoThe cost value
discount_percentnumberNoDiscount Percent
itemstringNoThe item value
namestringNoThe name value
positionintegerNoThe position value
pricenumberNoThe price value
product_categorystringNoProduct Category
product_idintegerNoProduct Id
quantitynumberNoThe quantity value
tax_notestringNoTax Note
tax_rate_idintegerNoTax Rate Id
taxablebooleanNoThe taxable value
upc_codestringNoUpc Code
user_idintegerNoUser Id

repairshopr_billing_update_invoices_by_id

Updates an existing invoice by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice to update
contact_idintegerNoContact Id
created_atstringNoCreated At
customer_idintegerNoCustomer Id
datestringNoThe date value
due_datestringNoDue Date
hardwarecostnumberNoThe hardwarecost value
location_idintegerNoLocation Id
notestringNoThe note value
numberstringNoThe number value
po_numberstringNoPo Number
ticket_idintegerNoTicket Id
updated_atstringNoUpdated At

repairshopr_billing_update_invoices_by_id_line_items_by_line_item_id

Updates an a line item of an invoice by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of Invoice to update
line_item_idintegerYesID of line item to update
costnumberNoThe cost value
discount_dollarsstringNoDiscount Dollars
itemstringNoThe item value
line_discount_percentintegerNoLine Discount Percent
namestringNoThe name value
pricenumberNoThe price value
taxablebooleanNoThe taxable value