GET an array of paginated jobs or POST a new one.

GET defaults to 25 jobs per page and without any other parameters starts with the most recent job, descending by job number.

POST requires two parameters, 'job_type_id' and 'customer_number'. Other fields may be supplied as desired. Early testing indicates that charges can not be supplied while creating a job. They must be added in a separate call; see /jobs/{id}.json or /jobs/{id}/job_charges.json.

See /customers/{id}/jobs.json for another way to create jobs. No difference between the two endpoints has been found. Note the format of a POST payload in the example below. A shortened version of active jobs (not canceled, lost, complete) list containing only the ID, name, and status is available at /tasks/job_list.json.

GET a specific job or opportunity as defined by the supplied job number.

PUT changes to a specific job or opportunity as defined by the supplied job number. Multiple changes can be made in a single call if they are included in the payload. For example: {job:{description:"A new description", scope_of_work:"An updated scope"}}. With the exception of keys that update as a result of the query, no keys will change. That means that if you update a job's description the scope of work won't change and doesn't have to be included in each query. However, there are some keys (such as 'updated_by', 'updated_at', etc) that will updated whether you want them to or not. As a general rule keys like those are not directly editable.

DELETE a specific job or opportunity as defined by the supplied job number.

GET an array of notes from a specific job or opportunity as defined by the supplied job number. Note objects at the job and customer level are indistinguishable except for one key, the noteable_type key. That key will be either 'Customer' or 'Job'. For customer-level notes, see /customers/{id}/notes.json.

POST a note to a specific job or opportunity as defined by the supplied job number.

GET a specific note for a specific job or opportunity as defined by the supplied job number and note ID. Note IDs are not easily visible in the web UI so the best way to obtain them is via the return from an endpoint like /jobs/{id}/notes.json.

PUT a change to a specific note for a specific job or opportunity as defined by the supplied job number and note ID.

DELETE a specific note for a specific job or opportunity as defined by the supplied job number and note ID.

GET all time entries (paginated) for a specific job or opportunity as defined by the supplied job number.

GET all charges (paginated) for a specific job or opportunity as defined by the supplied job number. Jobs are returned inside a 'job_charges' object.

POST a new charge to an specific job or opportunity as defined by the supplied job number. This is not a wipe-and-replace operation - the new charge will be added to any existing charges. The new charge is returned. item_id is the only key technically required to create a new charge, but see the note below.

An example charge object:

{
  "id": 7777777,
  "job_id": 88888888,
  "account_id": 70023,
  "created_on": "2020-03-19T13:59:47-04:00",
  "description": "Costume, Gorilla",
  "quantity": "2.0",
  "price_per_unit": "50.00",
  "item_id": 92929292,
  "qb_txn_line_id": null,
  "details": "A costume which resembles a gorilla",
  "item_ref_list_id": null,
  "txn_line_id": null,
  "total": "100.00",
  "job_charge_type_id": null,
  "updated_by": 565656,
  "recurring_item_parent_id": null,
  "deleted_at": null,
  "tax_id": null,
  "sales_tax_code_id": null,
  "discount": "0.0",
  "updated_at": "2020-03-19T13:59:47-04:00",
  "sort_order": null,
  "line_total": "100.00"
}
                        

Notice that the charge object contains the employee ID of the last employee to make a change to it, stored in the updated_by field.

GET a specific charge for a specific job or opportunity as defined by the supplied job number and charge ID.

PUT a change to a specific charge for a specific job or opportunity as defined by the supplied job number and charge ID.

DELETE a specific charge for a specific job or opportunity as defined by the supplied job number and charge ID. Unlike some other endpoints, deleting a charge simply returns a success message instead of the charge that was deleted.

GET always returns an empty array, but presumably it can take some parameters that make it return something useful. None have yet been identified. To retrieve tasks for a job or opportunity see /tasks.json.

POST a new task to an existing job or opportunity. This can be used to create a task of any type simply by changing the task_type_id value in the payload.

DELETE a specific charge for a specific job or opportunity as defined by the supplied job number and charge ID. Unlike some other endpoints, deleting a charge simply returns a success message instead of the charge that was deleted.

GET a specific task for a specific job or opportunity as defined by the supplied job number and task ID. Tasks generally contain glue records for the job, customer, primary contact (if defined for the customer), and employees assigned to the task.

PUT a change to a specific task for a specific job or opportunity as defined by the supplied job number and charge ID.

DELETE a specific task for a specific job or opportunity as defined by the supplied job number and task ID.

GET paginated payments for a specific job, as defined by the supplied job number. The pagination data returned is in the format of APIv3, meaning that it’s contained as follows:

{
  "payments": [ ...payment objects... ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": 2,
      "prev_page": null,
      "total_pages": 2,
      "total_count": 26
    }
  }
}
                        

A single payment object looks like this:

    {
      "id": 66554433,
      "created_at": "2021-03-02T11:22:57-05:00",
      "updated_at": "2021-03-02T15:24:24-05:00",
      "payment_type": "Credit Card",
      "amount": "168.22",
      "notes": null,
      "ref_number": null,
      "synced": true,
      "linked_payment_jobs": "<a href=\"/YOURSLUG/jobs/JOBNUMBER\">JOBNUMBER</a>",
      "formatted_amount": "$168.22",
      "job_numbers": [
        JOBNUMBER
      ],
      "date": "2021-03-02",
      "payment_application_ids": [
        33557332
      ],
      "customer_payment_url": "/YOURSLUG/customers/CUSTOMERNUMBER/payments/66554433",
      "edit_customer_payment_url": "/YOURSLUG/customers/CUSTOMERNUMBER/payments/66554433/edit",
      "xero_payment": null
    }
                        

POST a new payment for a specific job as defined by the supplied job number.

GET expenses for the job or opportunity specified by the supplied job number.

POST an expense for the job or opportunity identified by the supplied job number.

DELETE a specific task for a specific job or opportunity as defined by the supplied job number and task ID.

GET a specific expense for a specific job, as defined by the supplied job number and expense ID.

PUT a change to a specific expense for a specific job or opportunity as defined by the supplied job number and expense ID.

DELETE a specific expense for a specific job or opportunity as defined by the supplied job number and expense ID.

POST a new set of tags to a job or opportunity, as defined by the supplied job or opportunity number.