Tire Guru
Default module

Schemas

Appointment

  • shop_idnumber · required

    Unique Identifier

  • datestring · required
    Example: 2024-07-09T08:35:25.394Z
  • yearstring · required
  • makestring · required
  • modelstring · required
  • home_phonestring · required
  • work_phonestring · required
  • cell_phonestring · required
  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • doneboolean

    Is this appointment already completed?

    Default: false
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • statusstring | null

    The status of the associated work order (if linked)

  • first_namestring

    Customer information if customer_id is not provided

    Example: John
  • last_namestring

    Customer information if customer_id is not provided

    Example: Doe
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • email

    Customer information if customer_id is not provided

Appointment_Response

  • appointment_idnumber · required
  • shop_idnumber

    Unique Identifier

  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • first_namestring

    Customer information if customer_id is not provided

    Example: John
  • last_namestring

    Customer information if customer_id is not provided

    Example: Doe
  • vehicleobject | null
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • phoneobject | null
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • doneboolean

    Is this appointment already completed?

    Default: false
  • email

    Customer information if customer_id is not provided

  • sourcestring | null · enum
    Enum values:
    Website
    Tire Link
    Mobile
    Appointment
    Call Center
    Customer Portal
    Mobile Van
    API
  • scheduleobject
  • timestampstring

    The date to find scheduled appointments

    Example: 2024-07-09T08:35:25.394Z
  • updated_atstring | null
  • deletedstring | null
  • statusstring | null

    The status of the associated work order (if linked)

Bay

  • shop_idnumber · required

    Unique identifier of the shop

  • titlestring · required

    The title of the bay

    Example: Oil Change
  • idnumber · required

    Unique identifier of the bay

  • orderinteger · required

    The order the bay should show (lowest to highest, left to right)

    Example: 1
  • is_mobileboolean · required

    Is this bay a mobile van?

  • allow_overbookingboolean · required

    Does the bay allow overbooking?

Paginated_Appointment_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Appointment_Filters

  • first_namestring

    Customer information if customer_id is not provided

    Example: John
  • last_namestring

    Customer information if customer_id is not provided

    Example: Doe
  • reasonstring
  • yearinteger | string
    Example: 2023
  • makestring
    Example: Volkswagen
  • modelstring
    Example: Jetta
  • datestring

    The date of the appointment

  • timestring

    The time the appointment starts

ShipTo

  • numberstring · required

    The number assigned to the ship to

  • namestring · required

    The ship to name

    Example: John's Plumbing
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • emailstring | null · required
  • work_phonestring · required
    Example: 1234567899
  • faxstring · required
    Example: 1234567899
  • home_phonestring · required
    Example: 1234567899
  • cell_phonestring · required
    Example: 1234567899

ShipTo_Response

  • numberstring · required

    The number assigned to the ship to

  • namestring · required

    The ship to name

    Example: John's Plumbing
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • emailstring | null · required
  • work_phonestring · required
    Example: 1234567899
  • faxstring · required
    Example: 1234567899
  • home_phonestring · required
    Example: 1234567899
  • cell_phonestring · required
    Example: 1234567899
  • idnumber · required

    Unique identifier of the ship to

  • customer_idnumber · required

    Unique identifier of the customer the ship to is related to

Paginated_Ship_To_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Customer

  • shop_idnumber · required

    Unique Identifier

  • business_namestring · required
    Example: John's Plumbing
  • first_namestring · required

    Only required if business name not provided

    Example: John
  • last_namestring · required

    Only required if business name not provided

    Example: Doe
  • addressstring · required
    Example: 123 w 123 n
  • citystring · required
    Example: Logan
  • statestring · required
    Example: Utah
  • zipstring · required
  • home_phonestring
    Example: 1234567899
  • work_phonestring
    Example: 1234567899
  • cell_phonestring
    Example: 1234567899
  • faxstring
    Example: 1234567899
  • emailstring | null
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • credit_limitnumber
    Example: 500
  • extensionnumber
    Example: 123
  • customer_typestring
    Example: Retail
  • customer_pay_typestring

    Name of customer's terms

  • customer_numberstring
    Example: 456

Customer_Response

  • customer_idnumber

    Unique identifier of the customer

  • shop_idnumber

    Unique Identifier

  • business_namestring
    Example: John's Plumbing
  • first_namestring

    Only required if business name not provided

    Example: John
  • last_namestring

    Only required if business name not provided

    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phoneobject
  • emailstring | null
  • allow_marketingboolean
  • commentsstring
    Example: Likes us to call him when vehicle is done
  • cell_providerstring
    Example: Verizon
  • activeboolean
    Default: true
  • tax_exemptboolean

    Does the customer have a tax exempt certificate on file?

    Default: false
  • credit_limitnumber
    Example: 500
  • extensionstring
  • customer_typestring
    Example: Retail
  • termsstring
  • customer_numberstring
    Example: 456
  • customer_pay_typestring

    The customers Terms

  • timestampstring

    The created at time

  • home_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • cell_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • work_phonestring · deprecated · required

    This field is deprecated. Please use fields under the phone object

  • faxstring · deprecated · required

    This field is deprecated. Please use fields under the phone object

Employee

  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!

Employee_Response

  • employee_idnumber · required

    Unique identifier of the employee

  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • payment_typestring · required
  • commissionstring · required
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!

Employee_Types

string · enum
Enum values:
Salesperson
Technician
Tire Tech
Lube Tech
Management
Clerical
Driver
Warehouse
Example: Salesperson

Paginated_Employee_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Vehicle

  • customer_idnumber · required

    Unique identifier of the customer the vehicle is related to

  • yearinteger | string · required
    Example: 2023
  • makestring · required
    Example: Volkswagen
  • modelstring · required
    Example: Jetta
  • typestring · required
    Example: SE
  • vinstring
    Example: 123456789123456
  • license_numberstring
    Example: 123ASDF
  • license_statestring
    Example: Utah
  • fleet_numberstring

    This maps to Tire Guru's vehicle unit number

    Example: 123
  • colorstring
    Example: White
  • aces_idstring

Vehicle_Response

  • vehicle_idnumber · required

    Unique identifier of the vehicle

  • customer_idnumber · required

    Unique identifier of the customer the vehicle is related to

  • yearinteger | string · required
    Example: 2023
  • makestring · required
    Example: Volkswagen
  • modelstring · required
    Example: Jetta
  • typestring · required
    Example: SE
  • vinstring
    Example: 123456789123456
  • license_numberstring
    Example: 123ASDF
  • license_statestring
    Example: Utah
  • fleet_numberstring

    This maps to Tire Guru's vehicle unit number

    Example: 123
  • colorstring
    Example: White
  • aces_idstring

Get_Vehicles_Request

  • sortstring

    ort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -first_name. Sortable field: first_name, last_name, year, date and reason.

  • pageinteger

    Page number to return. Defaults to 1

  • pageSizeinteger

    string Number of items to return in a page. Defaults to 10.

  • with_detailsboolean
  • vehicle_idnumber

    Unique Identifier

  • filterobject

Paginated_Vehicles_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Supplier

  • shop_idnumber · required

    Unique identifier of the shop

  • supplier_namestring · required
    Example: John's Plumbing
  • supplier_addressstring · required
    Example: 123 w 123 n
  • supplier_citystring · required
    Example: Logan
  • supplier_statestring · required
    Example: Utah
  • supplier_zipstring · required
  • supplier_phonestring · required
    Example: 1234567899
  • account_numberstring · required

    The is the equivalent to Tire Guru's Vendor Number field

    Example: LPS30
  • supplier_faxstring
    Example: 1234567899
  • supplier_contactstring
    Example: John Doe
  • supplier_emailstring | null
  • urlstring | null
    Example: localpartstore.com
  • termsstring
    Example: Net 30
  • notesstring
    Example: Phone number is John's cell

Supplier_Response

  • supplier_idnumber · required

    Unique identifier of the supplier

  • shop_idnumber · required

    Unique identifier of the shop

  • available_company_wideboolean · required
  • supplierobject · required
  • account_numberstring · required

    The is the equivalent to Tire Guru's Vendor Number field

    Example: LPS30
  • online_orderingboolean · required
  • timestamprequired
  • urlstring | null
    Example: localpartstore.com
  • termsstring
    Example: Net 30
  • notesstring
    Example: Phone number is John's cell

Paginated_Suppliers_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Shop_Hours

  • shop_idnumber · required
  • dayinteger · required

    Day of week. 0=Sunday, 6=Saturday

    Example: 0
  • start_timestring · required
    Example: 08:00
  • end_timestring · required
    Example: 17:00
  • openboolean · required

Shop_Sources

  • idnumber · required
  • shop_idnumber · required
  • sourcestring · required
  • activeboolean · required

Create_Repair_Order_Request

  • shop_idnumber · required

    Unique identifier of the shop

  • customerobject · required

    Only provide this field if not providing a customer_id. This data will create a temporary customer and ignore the the customer_id field.

  • customer_idnumber

    Unique identifier of the customer the repair order is related to

  • vehicle_idnumber

    Unique identifier of the vehicle the repair order is related to

  • vehicleobject

    Only provide this field if not providing a vehicle_id. This data will create a temporary vehicle and ingore the vehicle_id field.

  • writerstring
    Example: John Doe
  • written_bystring
  • purchase_order_numberstring
  • commentsstring
    Example: Check for oil leak
  • sourcestring
  • reference_sourcestring
  • tread_depth_lrstring

    /32

    Example: 15
  • tread_depth_rfstring

    /32

    Example: 15
  • tread_depth_lfstring

    /32

    Example: 15
  • tread_depth_rrstring

    /32

    Example: 15
  • miles_instring
    Example: 45000
  • miles_outstring
    Example: 45000
  • urlstring

    URL to external website relating to the work order

    Example: https://example.com
  • tax_level_idnumber
  • price_level_idnumber
  • typestring · enum
    Enum values:
    repair_order
    quote
  • datestring
    Example: 2024-07-09T08:35:25.394Z
  • ship_to_idnumber

    Unique identifier of the ship to the repair order is related to

  • statusstring
  • routestring

    The name of the route

  • route_stopstring

    The stop number for the route. Must provide route if providing stop

Sublet_Reponse

  • sublet_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required

    Unique identifier of the shop

  • repair_order_idnumber · required

    Unique identifier of the repair order

  • sublet_descriptionstring · required
    Example: Sublet Labor
  • sublet_pricenumber · required
    Example: 89.55
  • sublet_costnumber · required
    Example: 67.44
  • sublet_invoice_numberstring · required
    Example: 12345
  • sublet_supplierstring · required
    Example: John's Tire Store
  • part_order_numberstring · required
    Example: 165135
  • is_taxableboolean · required
  • timestampstring · required

Part

  • shop_idnumber · required
  • part_idnumber · required
  • quantitynumber · required
    Example: 3
  • complaint_idnumber

    Can link to a complaint category

  • costnumber

    Dollar amount of cost for each. Cost should be for quantity of 1

    Example: 5.21
  • codestring

    Code to show in part number within RO

    Example: C125E
  • binstring
  • taxnumber

    Dollar amount of tax for each. Tax should be for quantity of 1

    Example: 1.15
  • fetnumber

    Dollar amount of FET for each. FET should be for quantity of 1

    Example: 2.22
  • partsnumber

    Dollar amount of parts for each. Parts should be for quantity of 1

    Example: 45.15
  • labornumber

    Dollar amount of labor for each. Labor should be for quantity of 1

    Example: 22.87
  • part_statusstring · enum
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • brandstring
  • descriptionstring
  • statusstring · enum
    Enum values:
    approved
    pending
    declined

Labor_Response

  • labor_idnumber · required
  • item_idnumber · required
  • shop_idnumber · required
  • repair_order_idnumber · required
  • complaint_idnumber · required
  • canned_jobs_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • hourly_ratestring · required
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • technicianstring · required
    Example: John Doe
  • line_totalnumber · required
  • sales1string · required
    Example: John Doe
  • sales2string · required
  • tech1string · required
  • tech2string · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started
  • timestampstring · required

    Time added to order

    Example: 2024-07-09T08:35:25.394Z
  • date_donestring · required

Item_Status

string · enum
Enum values:
not_started
in_progress
completed
Example: not_started

Recommended_Repair

  • idnumber · required
  • repair_order_idnumber · required
  • descriptionstring · required
    Example: Please check oil leak
  • total_recommendednumber · required
  • technician_notesstring · required
    Example: Oil leak looks like needs new drain plug
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • vehicle_idnumber · required
  • shop_idnumber · required
  • customer_idnumber · required
  • parent_idnumber

    If the recommended service is a child of another, this will be the id of the parent recommended service

Repair_Order_Response

  • repair_order_idnumber · required
  • shop_idnumber · required
  • repair_order_typestring · enum · required
    Enum values:
    repair_order
    quote
    Example: repair_order
  • statusstring | null · required
    Example: In Progress
  • writerstring · required
    Example: John Doe
  • tax_ratestring · required
  • purchase_order_numberstring · required
    Example: 123
  • tracking_numberstring · required
  • reference_numberstring · required
  • miles_innumber · required
  • miles_outnumber · required
  • commentsstring · required
    Example: This is a test comment
  • parts_costnumber · required
  • vehicleobject | null · required
  • customerobject | null · required
  • totalobject · required
  • date_instring · required
    Example: 2024-07-09T08:35:25.394Z
  • date_finalrequired
  • date_closedrequired
  • final_daterequired
  • status_daterequired
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • routestring
  • fees_discountsarray | null

    Only returned if 'with_details' in request is true

  • itemsarray | null

    Only returned if 'with_details' in request is true

Fee_and_Discount

  • idnumber · required
  • codestring · required
    Example: TRF
  • namestring · required
    Example: Tire Recycle Fee
  • quantitynumber · required
    Example: 1
  • pricenumber · required

    Price each - represents quantity of 1

    Example: 25
  • taxnumber · required

    Tax each - represents quantity of 1

    Example: 1
  • typestring · enum · required
    Enum values:
    fee
    discount
    Example: fee
  • shop_idstring · required

Complaint_Category

  • complaint_category_idnumber · required
  • namestring · required
  • activeboolean · required
  • colorstring · required
  • orderinteger · required

Repair_Order_Item

  • idnumber · required

    The ID representing the line item of the order

  • item_idnumber · required

    The ID for the item

  • quantitynumber · required
  • parts_eachnumber · required
  • labor_eachnumber · required
  • cost_eachnumber · required
  • taxnumber · required
  • fetnumber · required
  • totalnumber · required
  • codestring · required
  • descriptionstring · required
  • sizestring · required
  • labor_hoursnumber | null · required
  • statusstring · enum · required
    Enum values:
    approved
    pending
    declined
  • canned_job_idstring | null · required
  • complaint_idstring | null · required

    Can link to a complaint category

Get_Parts_Response

  • part_idnumber · required

    Represents the ID of the specific line item on the repair order

  • item_idnumber · required

    Represents the ID of the item

  • shop_idnumber · required
  • complaint_idnumber · required
  • repair_order_idnumber · required
  • canned_job_idrequired
  • partobject · required
  • total_pricenumber · required
  • part_order_numberstring · required
  • total_costnumber · required
  • binstring | null · required
  • taxnumber · required
  • order_statusstring | null · enum · required
    Enum values:
    received
    partially_received
    pending
  • sales_personstring · required
  • sales1string | null · required
  • sales2string | null · required
  • tech1string | null · required
  • tech2string | null · required
  • datestring · required
  • timestampstring · required

Sublet

  • shop_idnumber · required

    Unique identifier of the shop

  • descriptionstring · required
    Example: Sublet Labor
  • pricenumber · required
    Example: 89.55
  • costnumber · required
    Example: 67.44
  • complaint_id

    Unique identifier of the complaint

  • doneboolean

    Defaults to false

Labor

  • shop_idnumber · required
  • labor_idnumber · required
  • complaint_idnumber · required
  • rate_labelstring · required
    Example: Mount and Balance
  • labor_hoursnumber · required
    Example: 3
  • labornumber · required

    Total dollars for labor for each hour. Should represent a quantity of 1

    Example: 150
  • tech1string · required
    Example: John Doe
  • tech2string · required
  • sales1string · required
  • sales2string · required
  • sales_personstring · required
  • labor_statusstring · enum · required
    Enum values:
    not_started
    in_progress
    completed
    Example: not_started

Get_Fees_and_Discounts_Response

  • idnumber · required
  • codestring · required
    Example: TRF
  • namestring · required
    Example: Tire Recycle Fee
  • amountnumber · required
    Example: 1
  • amount_typestring · enum · required
    Enum values:
    Fixed Amount
    Adjust to QTY
    Adjusted Retail %
    Manual Amt
    Promotion
    Invoice Subtotal %
    Adjust QTY off Adjusted %
  • display_typestring · enum · required
    Enum values:
    part
    labor
  • minimumnumber · required
  • maximumnumber · required
  • quantitynumber · required
  • taxableboolean · required
  • typestring · enum · required
    Enum values:
    fee
    discount
  • shop_idnumber · required

Paginated_Response

  • linksobject · required
  • metaobject · required

Paginated_Request_Body

  • sortstring

    ort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -first_name. Sortable field: first_name, last_name, year, date and reason.

  • pageinteger

    Page number to return. Defaults to 1

  • pageSizeinteger

    string Number of items to return in a page. Defaults to 10.

First_Name

string
Example: John

Last_Name

string
Example: Doe

Business_Name

string
Example: John's Plumbing

Address

string
Example: 123 w 123 n

City

string
Example: Logan

State

string
Example: Utah

Zip

string

Phone_Number

string
Example: 1234567899

Email

string | null

Year

integer | string
Example: 2023

Vehicle_Make

string
Example: Volkswagen

Vehicle_Model

string
Example: Jetta

Vehicle_Type

string
Example: SE

Vehicle_Vin

string
Example: 123456789123456

Vehicle_License

string
Example: 123ASDF

Primary_Key

number

Date

string
Example: 2024-07-09T08:35:25.394Z

Inventory

  • part_idnumber
  • shop_idnumber
  • partobject
  • on_handnumber
  • allocatednumber
  • net_on_handnumber
  • reorder_levelnumber
  • max_on_handnumber
  • maintain_stockstring
    Example: YES
  • binstring
    Example:
  • taxboolean

    Is item taxable?

  • notesstring
    Example:
  • timestampstring
    Example: 2014-11-18T20:38:34.000000Z
  • custom_fieldsobject[]

Paginated_Inventory_Response

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Get_Bins_Response

  • bin_idnumber
  • codestring
  • descriptionstring
  • max_quantitynumber
  • activeboolean
  • shop_idnumber

Get_Groups_Response

  • manufacturer_idnumber · required
  • group_idnumber · required
  • descriptionstring · required
  • activeboolean · required
  • created_bystring | null · required
  • created_atrequired

Get_Manufacturers_Response

  • manufacturer_idnumber · required
  • namestring · required
  • activeboolean · required
  • created_atstring | null · required
  • created_byrequired

Canned_Job

  • canned_job_idnumber · required
  • job_namestring · required
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • orderinteger · required
  • subcategoriesarray | null

Get_Purchase_Orders_Response

  • purchase_order_idnumber · required
  • supplier_idnumber · required
  • shop_idnumber · required
  • supplier_namestring · required
  • purchase_order_numberstring · required
  • referencestring · required
  • trackingstring · required
  • ship_viastring | null · required
  • notesstring | null · required
  • totalnumber · required
  • created_atstring · required
  • locked_atstring | null · required
  • received_atstring | null · required
  • etastring | null · required
  • ordered_bystring · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • itemsobject[]

Get_Expense_Items_Response

  • expense_item_idstring · required
  • codestring · required
  • descriptionstring · required
  • is_freightboolean · required
  • activeboolean · required
  • shop_idnumber · required

Get_Purchase_Order_Item_Response

  • purchase_order_item_idnumber · required

    The unique id for the line item in the purchase order

  • costnumber · required
  • quantitynumber · required
  • allocatednumber · required
  • availablenumber · required
  • locked_atrequired
  • received_atrequired
  • backordered_atrequired
  • totalnumber · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • item_id

    Required if expense_id is not provided

  • expense_item_idstring | null
  • codestring
  • sizestring
  • rawsizestring
  • descriptionstring
  • fetnumber | null

Purchase_Order_Item

  • quantitynumber · required
  • item_idnumber

    Required when expense_item_id not provided

  • expense_item_idnumber

    Required when item_id not provided

  • sizestring

    Will override item's size

  • codestring

    Will override item's code

  • descriptionstring

    Will override item's description

  • costnumber

    Will override item's cost

  • fetnumber

    Will override item's fet

  • binstring

Purchase_Order_Status

string · enum
Enum values:
open
locked
received
backordered

Create_Purchase_Order_Request

  • supplier_idnumber · required
  • shop_idnumber · required
  • invoice_numberstring · required

    Required when updating to a received status

  • referencestring
  • trackingstring
  • ship_viastring
  • notesstring
  • etastring
    Example: 2024-07-09T08:35:25.394Z
  • order_bystring

    The name of the user who created the order

  • statusstring · enum

    Defaults to open

    Enum values:
    open
    locked
    received

Create_Notification_Request

  • titlestring · required
  • descriptionstring · required
  • shop_idnumber · required
  • employee_idsnumber[]
  • dataobject

Route

  • idnumber · required

    ID

  • namestring · required
  • descriptionstring

Customer_Accounts_Receivable

  • idnumber · required

    Primary key for the payment

  • customer_idnumber · required

    Primary key for the customer

  • shop_idnumber · required

    Primary key of the shop that the AR incurred from

  • numberstring · required

    The AR number

  • amountnumber · required

    Amount of payment (negative if adding balance)

  • discountnumber · required

    Amount of discount applied

  • remainingnumber · required

    Amount remaining after payments and discounts

  • datestring · required

    Date AR was added

    Example: 2024-07-09T08:35:25.394Z
  • due_datestring · required

    Due date of AR

    Example: 2024-07-09T08:35:25.394Z
  • actual_datestring · required

    The actual timestamp that the AR was created

  • typestring · enum · required

    Type of AR

    Enum values:
    invoice
    service_charge
    unapplied
    late_fee
    gl_roa
    deposit
  • referencestring · required

    Reference number for this AR post

  • paymentsobject[] · required

    A list of all payments made towards this AR balance

  • repair_order_id

    The primary key of the related repair order

  • notesstring | null

    Notes related to this AR post

Shop_Info

  • shop_idnumber · required
  • namestring · required
  • addressstring · required
  • citystring · required
  • statestring · required
  • zipstring · required
  • numberstring
  • phonestring
  • emailstring
  • websitestring
  • logo_urlstring
  • metaobject

General_Ledger_Post

  • idnumber · required

    Primary key of the GL entry

  • namestring · required

    Name of the journal for the GL entry

  • descriptionstring · required

    Description of the entry

  • actual_datestring · required

    Date actual entry was made

    Example: 2024-07-09T08:35:25.394Z
  • posted_datestring · required

    Date entry was posted to

    Example: 2024-07-09T08:35:25.394Z
  • source_typestring · enum · required

    Type of payment:

    Enum values:
    Manual Journal Entry
    Sales Journal
    Inventory Receipts Journal
    A/R - Cash Journal
    A/R - Cash Journal (Corporate)
    Purchase Journal
    Payroll Journal
    Service Charge Journal
  • typestring · enum · required

    Debit or Credit

    Enum values:
    debit
    credit
  • amountnumber · required

    Amount of post

  • majornumber · required

    Number for major account

  • major_namestring · required

    Major account name

  • minornumber · required

    Number for minor account

  • minor_namestring · required

    Minor account name

  • is_manualboolean · required

    Was the entry a manually added entry

  • shop_idnumber · required

Workflow_Status

  • status_idnumber · required
  • namestring · required
  • descriptionstring · required
  • orderinteger · required
  • colorstring | null · pattern: ^#[0-9A-Fa-f]{6}$ · required

Create_Wholesale_Order_Request

  • fill_killstring · enum · required
    Enum values:
    fok
    fak
    back
  • shop_idnumber · required
  • customer_idnumber · required
  • itemsobject[] · required
  • ship_to_idnumber
  • purchase_order_numberstring
  • tracking_numberstring
  • reference_numberstring
  • statusstring
  • urlstring
  • routestring
  • route_stopstring
  • commentsstring

Wholesale_Order_Response

  • order_idstring · required
  • order_numberstring · required
  • shop_idstring · required
  • itemsobject[] · required
  • totalobject · required
  • statusstring
  • purchase_order_numberstring
  • tracking_numberstring
  • reference_numberstring
  • routeobject

Color

string | null · pattern: ^#[0-9A-Fa-f]{6}$

Status

string · enum
Enum values:
approved
pending
declined

Inspection_Response

  • idnumber · required
  • shop_idnumber · required
  • inspection_namestring · required
  • created_atstring · required
    Example: 2024-07-09T08:35:25.394Z
  • updated_atstring · required
    Example: 2024-07-09T08:35:25.394Z
  • repair_order_idnumber · required
  • vehicle_idnumber · required
  • resultsobject[] · required
  • completed_at
  • completed_by_employee_namestring | null
  • completed_by_employee_id
  • customer_id

Inspection_Result

  • idnumber · required
  • titlestring · required

    The title for the inspection result question

  • findingsobject[] · required
  • determinationstring | null · enum

    Determination often represents the red, yellow, green field

    Enum values:
    CRITICAL
    WARN
    OK
  • measurementsarray | null
  • attachmentsarray | null

    List of attachments for the result