Ex. GET /invoices.json retrieves the first page of invoices for the account.

Ex. GET /invoices.json?invoice_status=paid retrieves the first page of paid invoices for the account.

Ex. GET /invoices.json?invoice_status=unpaid&page=2 retrieves the second page of unpaid invoices for the account.

Ex. GET /opportunities.json retrieves the first page of opportunities for the account.

Ex. GET /opportunities.json?status=new retrieves the first page of opportunities in ‘new’ status for the account.

Ex. GET /opportunities.json?job_type_id=24680&page=2 retrieves the second page of opportunities with service 24680 for the account.

Ex. PUT /opportunities/12345/mark_as_lost.json marks opportunity number 12345 as 'lost'.

Ex. PUT /opportunities/12345/mark_as_won.json marks opportunity number 12345 as 'won'.

Ex. GET /employees.json returns an array of all active employees. Each entry will be similar to:

{
  "id": 846787,
  "account_id": 222222,
  "employee_number": 17,
  "name": "User Name",
  "admin": false,
  "active": true,
  "limit_access_to_assignments": false,
  "email_address": "user@somedomain.com",
  "username": "someusername",
  "address": "",
  "city": "",
  "state": "",
  "zip_code": "12345",
  "avatar": "https://someurl.png"
}  

Ex. GET /employees/6.json returns employee number 6. The format is identical to each entry in the array returned by /employees.json:

{
  "id": 846787,
  "account_id": 222222,
  "employee_number": 17,
  "name": "User Name",
  "admin": false,
  "active": true,
  "limit_access_to_assignments": false,
  "email_address": "user@somedomain.com",
  "username": "someusername",
  "address": "",
  "city": "",
  "state": "",
  "zip_code": "12345",
  "avatar": "https://someurl.png"
}   

Ex. GET /vendors.json retrieves paginated vendors for the account. An example entry:

{
  "id": 555666777,
  "account_id": 112233,
  "name": "Wingus, Dingus & Doofus Attorneys at Law",
  "active": true,
  "created_at": "2020-12-23T06:27:50-07:00",
  "updated_at": "2020-12-23T06:27:50-07:00",
  "list_id": null
} 

Ex. POST {name:"Herp & Derp Accountants"} /vendors.json creates a new vendor with the supplied name. The new vendor object is returned. It contains an 'errors' key, which, if the name has already been used, will contain 'Name has already been taken'.

Ex. PUT {name:"Hyphen and Comma, Punctuation Suppliers"} /vendors/159753.json changes the name of vendor 159753. The updated vendor object is returned. It contains an ‘errors’ key in case there was a problem with the supplied parameter.

Ex. GET /items.json returns the first page of items associated with the account. An example object:

{
  "id": 9955112233,
  "account_id": 335577,
  "created_on": "2019-12-19T05:55:46-07:00",
  "updated_on": "2021-02-25T07:28:29-07:00",
  "parent_list_id": null,
  "list_id": null,
  "edit_sequence": null,
  "name": "Widget",
  "sublevel": 0,
  "item_type": "",
  "price": "1.45",
  "active": true,
  "sales_tax_code_ref_full_name": null,
  "full_name": "Widget",
  "description": "A widget of some sort.",
  "sales_tax_code_ref_list_id": null,
  "tax_rate": null,
  "discount_rate": null,
  "discount_rate_percent": null,
  "taxable": false,
  "qb_error": null,
  "sales_tax_code_id": null,
  "updated_at": "2021-02-25T07:28:29-07:00",
  "formatted_price": "$1.45"
}

Ex. GET /items.json?name=Vio will return all items (paginated) whose name contains 'vio' (not case-sensitive). The records returned are truncated, containing only the fields outlined below. An example return:

"items": [
    {
      "id": 2536840,
      "name": "Violin Maintenance",
      "price": "55.0",
      "description": "Preventative maintenance on violin",
      "taxable": true,
      "formatted_price": "$55.00"
    }
],
"current_page": 1,
"per_page": 25,
"total_entries": 1,
"total_pages": 1,
"next_page": null,
"previous_page": null

Ex. GET /schedule.json retrieves paginated tasks for the account.

Ex. GET /schedule.json?per_page=5&page=2 retrieves the second page of tasks, if a page is treated as 5 tasks.

Ex. GET /schedule.json?employee_number=4&task_type_id=2222 retrieves all tasks for employee number 4 of type 2222.

Ex. GET /payments.json retrieves paginated payments for the account.

Ex. GET /payments.json?per_page=5&page=2 retrieves the second page of payments, if a page is treated as 5 tasks.

Ex. GET /payments.json?customer_id=2673 retrieves paginated payments for customer 2673. Note that despite the parameter name, the supplied value is actually the customer number, not the ID.

Ex. GET /payments.json?customer_id=2673&sort_by=created_at&sort_order=DESC retrieves paginated payments for customer 2673 sorted by payment creation date (some other fields are also 'sortable') in descending order ('ASC' is also a valid value for sort_order).

Ex. GET /job_types.json retrieves paginated job types for the account. An example object, contained inside a job_types array:

{
  "id": 9948757,
  "account_id": 12345,
  "name": "Yodeling Lessons",
  "color": "000",
  "position": 99,
  "active": true,
  "created_at": "2020-06-26T11:46:30-04:00",
  "updated_at": "2020-06-26T11:46:30-04:00",
  "description": "",
  "cost": "",
  "time": 0,
  "text_color": "fff",
  "public": false
}    

Ex. GET /job_types.json?inactive=true returns paginated inactive job_types (defaults to only returning active job_types).

Ex. GET /job_types.json?all=true returns paginated active and inactive job_types.

Ex. GET /job_charge_types.json retrieves the first page of job_charge_types.

{
  "job_charge_types": [
    {
      "id": 12345,
      "account_id": 11111,
      "name": "Hourly",
      "active": true,
      "created_at": "2020-03-03T16:46:15-05:00",
      "updated_at": "2020-03-03T16:46:15-05:00"
    },
    {
      "id": 12346,
      "account_id": 11111,
      "name": "Non-recurring",
      "active": true,
      "created_at": "2020-03-04T14:59:47-05:00",
      "updated_at": "2020-03-04T14:59:47-05:00"
    }
  ],
  "current_page": 1,
  "per_page": 25,
  "total_entries": 5,
  "total_pages": 1,
  "next_page": null,
  "previous_page": null
}