Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /repairshopr-billing | Type: Application | PCID required: Yes
repairshopr_billing_create_customers_by_customer_id_payment_profiles
Creates a Payment Profile
Parameters:
Parameter Type Required Default Description customer_idinteger Yes — Customer Id customer_external_idstring No — Payment Gateway’s Customer token expirationstring No — The expiration value last_fourstring No — Last Four payment_profile_idstring No — Payment Gateway’s stored payment profile token
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"customer_external_id" : {
"type" : "string" ,
"description" : "Payment Gateway's Customer token"
},
"expiration" : {
"type" : "string" ,
"description" : "The expiration value"
},
"last_four" : {
"type" : "string" ,
"description" : "Last Four"
},
"payment_profile_id" : {
"type" : "string" ,
"description" : "Payment Gateway's stored payment profile token"
}
},
"required" : [
"PCID" ,
"customer_id"
]
}
repairshopr_billing_create_estimates
Creates an Estimate
Parameters:
Parameter Type Required Default Description created_atstring No — Created At customer_idinteger No — Customer Id datestring No — The date value line_itemsobject[] No — Array of Line Items. location_idinteger No — Location Id namestring No — The name value notestring No — The note value numberstring No — The number value statusstring No — Valid values are Fresh, Draft, Approved, Declined. ticket_idinteger No — Ticket Id updated_atstring No — Updated At
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"created_at" : {
"type" : "string" ,
"description" : "Created At"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"date" : {
"type" : "string" ,
"description" : "The date value"
},
"line_items" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Array of Line Items."
},
"location_id" : {
"type" : "integer" ,
"description" : "Location Id"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"note" : {
"type" : "string" ,
"description" : "The note value"
},
"number" : {
"type" : "string" ,
"description" : "The number value"
},
"status" : {
"type" : "string" ,
"description" : "Valid values are Fresh, Draft, Approved, Declined."
},
"ticket_id" : {
"type" : "integer" ,
"description" : "Ticket Id"
},
"updated_at" : {
"type" : "string" ,
"description" : "Updated At"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_create_estimates_by_id_convert_to_invoice
Convert an Estimate to an Invoice
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_estimates_by_id_email
Sends an Estimate to a Customer
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_estimates_by_id_line_items
Adds a Line Item to an Estimate
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value costnumber No — The cost value discount_percentnumber No — Discount Percent itemstring No — The item value namestring No — The name value positioninteger No — The position value pricenumber No — The price value product_categorystring No — Product Category product_idinteger No — Product Id quantitynumber No — The quantity value tax_notestring No — Tax Note tax_rate_idinteger No — Tax Rate Id taxableboolean No — The taxable value upc_codestring No — Upc Code user_idinteger No — User Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
},
"cost" : {
"type" : "number" ,
"description" : "The cost value"
},
"discount_percent" : {
"type" : "number" ,
"description" : "Discount Percent"
},
"item" : {
"type" : "string" ,
"description" : "The item value"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"position" : {
"type" : "integer" ,
"description" : "The position value"
},
"price" : {
"type" : "number" ,
"description" : "The price value"
},
"product_category" : {
"type" : "string" ,
"description" : "Product Category"
},
"product_id" : {
"type" : "integer" ,
"description" : "Product Id"
},
"quantity" : {
"type" : "number" ,
"description" : "The quantity value"
},
"tax_note" : {
"type" : "string" ,
"description" : "Tax Note"
},
"tax_rate_id" : {
"type" : "integer" ,
"description" : "Tax Rate Id"
},
"taxable" : {
"type" : "boolean" ,
"description" : "The taxable value"
},
"upc_code" : {
"type" : "string" ,
"description" : "Upc Code"
},
"user_id" : {
"type" : "integer" ,
"description" : "User Id"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_estimates_by_id_print
Queues a print job for an Estimate
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_invoices
Creates an Invoice
Parameters:
Parameter Type Required Default Description contact_idinteger No — Contact Id created_atstring No — Created At customer_idinteger Yes — Customer Id datestring Yes — The date value due_datestring No — Due Date hardwarecostnumber No — The hardwarecost value line_itemsobject[] No — Line Items location_idinteger No — Location Id notestring No — The note value numberstring Yes — The number value po_numberstring No — Po Number ticket_idinteger No — Ticket Id updated_atstring No — Updated At
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"contact_id" : {
"type" : "integer" ,
"description" : "Contact Id"
},
"created_at" : {
"type" : "string" ,
"description" : "Created At"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"date" : {
"type" : "string" ,
"description" : "The date value"
},
"due_date" : {
"type" : "string" ,
"description" : "Due Date"
},
"hardwarecost" : {
"type" : "number" ,
"description" : "The hardwarecost value"
},
"line_items" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Line Items"
},
"location_id" : {
"type" : "integer" ,
"description" : "Location Id"
},
"note" : {
"type" : "string" ,
"description" : "The note value"
},
"number" : {
"type" : "string" ,
"description" : "The number value"
},
"po_number" : {
"type" : "string" ,
"description" : "Po Number"
},
"ticket_id" : {
"type" : "integer" ,
"description" : "Ticket Id"
},
"updated_at" : {
"type" : "string" ,
"description" : "Updated At"
}
},
"required" : [
"PCID" ,
"customer_id" ,
"date" ,
"number"
]
}
repairshopr_billing_create_invoices_by_id_email
Sends invoice to customer
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of Invoice which will be emailed
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice which will be emailed"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_invoices_by_id_line_items
Creates a new line item
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of Invoice to update costnumber No — The cost value discount_dollarsstring No — Discount Dollars itemstring No — The item value line_discount_percentinteger No — Line Discount Percent namestring No — The name value pricenumber No — The price value taxableboolean No — The taxable value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice to update"
},
"cost" : {
"type" : "number" ,
"description" : "The cost value"
},
"discount_dollars" : {
"type" : "string" ,
"description" : "Discount Dollars"
},
"item" : {
"type" : "string" ,
"description" : "The item value"
},
"line_discount_percent" : {
"type" : "integer" ,
"description" : "Line Discount Percent"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"price" : {
"type" : "number" ,
"description" : "The price value"
},
"taxable" : {
"type" : "boolean" ,
"description" : "The taxable value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_invoices_by_id_print
Queues a print job for an invoice
Parameters:
Parameter Type Required Default Description idinteger Yes — The ID of the Invoice to print
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The ID of the Invoice to print"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_create_payments
Creates a Payment
Parameters:
Parameter Type Required Default Description address_citystring No — Address City address_streetstring No — Address Street address_zipstring No — Address Zip amount_centsinteger No — Amount Cents apply_paymentsobject No — Object where a key is an Invoice ID and a value is a payment amount to be applied to the invoice. customer_idinteger No — Customer Id date_monthstring No — Date Month date_yearstring No — Date Year firstnamestring No — The firstname value invoice_idinteger No — Invoice Id invoice_numberstring No — Invoice Number lastnamestring No — The lastname value payment_methodstring No — Payment Method ref_numstring No — Ref Num register_idinteger No — Register Id signature_datastring No — Signature Data signature_datestring No — Signature Date signature_namestring No — Signature Name
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"address_city" : {
"type" : "string" ,
"description" : "Address City"
},
"address_street" : {
"type" : "string" ,
"description" : "Address Street"
},
"address_zip" : {
"type" : "string" ,
"description" : "Address Zip"
},
"amount_cents" : {
"type" : "integer" ,
"description" : "Amount Cents"
},
"apply_payments" : {
"type" : "object" ,
"description" : "Object where a key is an Invoice ID and a value is a payment amount to be applied to the invoice."
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"date_month" : {
"type" : "string" ,
"description" : "Date Month"
},
"date_year" : {
"type" : "string" ,
"description" : "Date Year"
},
"firstname" : {
"type" : "string" ,
"description" : "The firstname value"
},
"invoice_id" : {
"type" : "integer" ,
"description" : "Invoice Id"
},
"invoice_number" : {
"type" : "string" ,
"description" : "Invoice Number"
},
"lastname" : {
"type" : "string" ,
"description" : "The lastname value"
},
"payment_method" : {
"type" : "string" ,
"description" : "Payment Method"
},
"ref_num" : {
"type" : "string" ,
"description" : "Ref Num"
},
"register_id" : {
"type" : "integer" ,
"description" : "Register Id"
},
"signature_data" : {
"type" : "string" ,
"description" : "Signature Data"
},
"signature_date" : {
"type" : "string" ,
"description" : "Signature Date"
},
"signature_name" : {
"type" : "string" ,
"description" : "Signature Name"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_delete_customers_by_customer_id_payment_profiles_by_id
Deletes a Payment Profile
Parameters:
Parameter Type Required Default Description customer_idinteger Yes — Customer Id idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"customer_id" ,
"id"
]
}
repairshopr_billing_delete_estimates_by_id
Deletes an Estimate by ID
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_delete_estimates_by_id_line_items_by_line_item_id
Deletes a Line Item
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value line_item_idinteger Yes — Line Item Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
},
"line_item_id" : {
"type" : "integer" ,
"description" : "Line Item Id"
}
},
"required" : [
"PCID" ,
"id" ,
"line_item_id"
]
}
repairshopr_billing_delete_invoices_by_id
Deletes an invoice by ID
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of Invoice to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
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 idinteger Yes — ID of Invoice to delete line_item_idinteger Yes — ID of line item to update
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice to delete"
},
"line_item_id" : {
"type" : "integer" ,
"description" : "ID of line item to update"
}
},
"required" : [
"PCID" ,
"id" ,
"line_item_id"
]
}
repairshopr_billing_get_customers_by_customer_id_payment_profiles
Returns a paginated list of Payment Profiles
Parameters:
Parameter Type Required Default Description customer_idinteger Yes — Customer Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
}
},
"required" : [
"PCID" ,
"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_idinteger Yes — Customer Id idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"customer_id" ,
"id"
]
}
repairshopr_billing_get_estimates_by_id
Retrieves an Estimate by ID or number
Parameters:
Parameter Type Required Default Description idinteger Yes — Estimate ID numberstring No — Estimate number is used when the server cannot find an Estimate by ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "Estimate ID"
},
"number" : {
"type" : "string" ,
"description" : "Estimate number is used when the server cannot find an Estimate by ID"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_get_invoices_by_id
Retrieves an Invoice by ID or Number
Parameters:
Parameter Type Required Default Description idinteger Yes — ID or Number of Invoice to retrieve
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID or Number of Invoice to retrieve"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_get_invoices_by_id_ticket
Returns the associated ticket for an invoice
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of Invoice whose Ticket will be returned
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice whose Ticket will be returned"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_get_payments_by_id
Retrieves a Payment by ID
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_list_estimates
Returns a paginated list of Estimates
Parameters:
Parameter Type Required Default Description mineboolean No — Returns estimates that belong to the current user statusstring No — Returns estimates with a given status. Possible values are ‘approved’ and ‘declined’. pageinteger No — Returns provided page of results, each ‘page’ contains 50 results
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"mine" : {
"type" : "boolean" ,
"description" : "Returns estimates that belong to the current user"
},
"status" : {
"type" : "string" ,
"description" : "Returns estimates with a given status. Possible values are 'approved' and 'declined'."
},
"page" : {
"type" : "integer" ,
"description" : "Returns provided page of results, each 'page' contains 50 results"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_list_invoices
Returns a paginated list of Invoices
Parameters:
Parameter Type Required Default Description paidboolean No — Whether or not the returned list of invoices has been marked as paid unpaidboolean No — Whether or not the returned list of invoices has been marked as unpaid ticket_idinteger No — Any invoices attached to a Ticket ID since_updated_atstring No — Any invoices updated since a date pageinteger No — Returns provided page of results, each ‘page’ contains 25 results
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"paid" : {
"type" : "boolean" ,
"description" : "Whether or not the returned list of invoices has been marked as paid"
},
"unpaid" : {
"type" : "boolean" ,
"description" : "Whether or not the returned list of invoices has been marked as unpaid"
},
"ticket_id" : {
"type" : "integer" ,
"description" : "Any invoices attached to a Ticket ID"
},
"since_updated_at" : {
"type" : "string" ,
"description" : "Any invoices updated since a date"
},
"page" : {
"type" : "integer" ,
"description" : "Returns provided page of results, each 'page' contains 25 results"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_list_line_items
Returns a paginated list of Line Items
Parameters:
Parameter Type Required Default Description invoice_idinteger No — Returns Line Items that belong to an Invoice ID estimate_idinteger No — Returns Line Items that belong to an Estimate ID invoice_id_not_nullboolean No — Returns Line Items that belong to any Invoice estimate_id_not_nullboolean No — Returns Line Items that belong to any Estimate
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"invoice_id" : {
"type" : "integer" ,
"description" : "Returns Line Items that belong to an Invoice ID"
},
"estimate_id" : {
"type" : "integer" ,
"description" : "Returns Line Items that belong to an Estimate ID"
},
"invoice_id_not_null" : {
"type" : "boolean" ,
"description" : "Returns Line Items that belong to any Invoice"
},
"estimate_id_not_null" : {
"type" : "boolean" ,
"description" : "Returns Line Items that belong to any Estimate"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_list_payment_methods
Returns a paginated list of Payment Methods
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_list_payments
Returns a paginated list of Payments
Parameters:
Parameter Type Required Default Description querystring No — Search query pageinteger No — Returns provided page of results, each ‘page’ contains 25 results
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"query" : {
"type" : "string" ,
"description" : "Search query"
},
"page" : {
"type" : "integer" ,
"description" : "Returns provided page of results, each 'page' contains 25 results"
}
},
"required" : [
"PCID"
]
}
repairshopr_billing_update_customers_by_customer_id_payment_profiles_by_id
Updates a Payment Profile
Parameters:
Parameter Type Required Default Description customer_idinteger Yes — Customer Id idinteger Yes — The id value expirationstring No — The expiration value last_fourstring No — Last Four
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
},
"expiration" : {
"type" : "string" ,
"description" : "The expiration value"
},
"last_four" : {
"type" : "string" ,
"description" : "Last Four"
}
},
"required" : [
"PCID" ,
"customer_id" ,
"id"
]
}
repairshopr_billing_update_estimates_by_id
Updates an existing Estimate by ID
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value customer_idinteger No — Customer Id datestring No — The date value location_idinteger No — Location Id namestring No — The name value notestring No — The note value numberstring No — The number value statusstring No — Valid values are Fresh, Draft, Approved, Declined. ticket_idinteger No — Ticket Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"date" : {
"type" : "string" ,
"description" : "The date value"
},
"location_id" : {
"type" : "integer" ,
"description" : "Location Id"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"note" : {
"type" : "string" ,
"description" : "The note value"
},
"number" : {
"type" : "string" ,
"description" : "The number value"
},
"status" : {
"type" : "string" ,
"description" : "Valid values are Fresh, Draft, Approved, Declined."
},
"ticket_id" : {
"type" : "integer" ,
"description" : "Ticket Id"
}
},
"required" : [
"PCID" ,
"id"
]
}
repairshopr_billing_update_estimates_by_id_line_items_by_line_item_id
Updates a Line Item
Parameters:
Parameter Type Required Default Description idinteger Yes — The id value line_item_idinteger Yes — Line Item Id costnumber No — The cost value discount_percentnumber No — Discount Percent itemstring No — The item value namestring No — The name value positioninteger No — The position value pricenumber No — The price value product_categorystring No — Product Category product_idinteger No — Product Id quantitynumber No — The quantity value tax_notestring No — Tax Note tax_rate_idinteger No — Tax Rate Id taxableboolean No — The taxable value upc_codestring No — Upc Code user_idinteger No — User Id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "The id value"
},
"line_item_id" : {
"type" : "integer" ,
"description" : "Line Item Id"
},
"cost" : {
"type" : "number" ,
"description" : "The cost value"
},
"discount_percent" : {
"type" : "number" ,
"description" : "Discount Percent"
},
"item" : {
"type" : "string" ,
"description" : "The item value"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"position" : {
"type" : "integer" ,
"description" : "The position value"
},
"price" : {
"type" : "number" ,
"description" : "The price value"
},
"product_category" : {
"type" : "string" ,
"description" : "Product Category"
},
"product_id" : {
"type" : "integer" ,
"description" : "Product Id"
},
"quantity" : {
"type" : "number" ,
"description" : "The quantity value"
},
"tax_note" : {
"type" : "string" ,
"description" : "Tax Note"
},
"tax_rate_id" : {
"type" : "integer" ,
"description" : "Tax Rate Id"
},
"taxable" : {
"type" : "boolean" ,
"description" : "The taxable value"
},
"upc_code" : {
"type" : "string" ,
"description" : "Upc Code"
},
"user_id" : {
"type" : "integer" ,
"description" : "User Id"
}
},
"required" : [
"PCID" ,
"id" ,
"line_item_id"
]
}
repairshopr_billing_update_invoices_by_id
Updates an existing invoice by ID
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of Invoice to update contact_idinteger No — Contact Id created_atstring No — Created At customer_idinteger No — Customer Id datestring No — The date value due_datestring No — Due Date hardwarecostnumber No — The hardwarecost value location_idinteger No — Location Id notestring No — The note value numberstring No — The number value po_numberstring No — Po Number ticket_idinteger No — Ticket Id updated_atstring No — Updated At
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice to update"
},
"contact_id" : {
"type" : "integer" ,
"description" : "Contact Id"
},
"created_at" : {
"type" : "string" ,
"description" : "Created At"
},
"customer_id" : {
"type" : "integer" ,
"description" : "Customer Id"
},
"date" : {
"type" : "string" ,
"description" : "The date value"
},
"due_date" : {
"type" : "string" ,
"description" : "Due Date"
},
"hardwarecost" : {
"type" : "number" ,
"description" : "The hardwarecost value"
},
"location_id" : {
"type" : "integer" ,
"description" : "Location Id"
},
"note" : {
"type" : "string" ,
"description" : "The note value"
},
"number" : {
"type" : "string" ,
"description" : "The number value"
},
"po_number" : {
"type" : "string" ,
"description" : "Po Number"
},
"ticket_id" : {
"type" : "integer" ,
"description" : "Ticket Id"
},
"updated_at" : {
"type" : "string" ,
"description" : "Updated At"
}
},
"required" : [
"PCID" ,
"id"
]
}
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 idinteger Yes — ID of Invoice to update line_item_idinteger Yes — ID of line item to update costnumber No — The cost value discount_dollarsstring No — Discount Dollars itemstring No — The item value line_discount_percentinteger No — Line Discount Percent namestring No — The name value pricenumber No — The price value taxableboolean No — The taxable value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of Invoice to update"
},
"line_item_id" : {
"type" : "integer" ,
"description" : "ID of line item to update"
},
"cost" : {
"type" : "number" ,
"description" : "The cost value"
},
"discount_dollars" : {
"type" : "string" ,
"description" : "Discount Dollars"
},
"item" : {
"type" : "string" ,
"description" : "The item value"
},
"line_discount_percent" : {
"type" : "integer" ,
"description" : "Line Discount Percent"
},
"name" : {
"type" : "string" ,
"description" : "The name value"
},
"price" : {
"type" : "number" ,
"description" : "The price value"
},
"taxable" : {
"type" : "boolean" ,
"description" : "The taxable value"
}
},
"required" : [
"PCID" ,
"id" ,
"line_item_id"
]
}