API Overview

Discover just how easy it is to integrate your systems with JobFile. The following is a simplified version showing the data fields mapped in our API for easy integration with your system.

Job

Get a job list, create or update job, upload all the forecast data, retrieve a job by ID or job number and remove a job by ID or job number are all functions that can be undertaken using the Jobs API.

More specific job details provided include;

Job ID, Job Address (broken down into: Lot, Street, Suburb, State and Postcode) Longitude and Latitude, Job Supervisor, Job Status, Job Owner, Instructions and Directions, Estimated and Actual Start and Completed dates.

Task

Get a task list, create a task, retrieve a task by task ID, update a task by task ID or remove a task by task ID are all functions that can be undertaken using the Tasks API.

More specific task details provided include;

Task ID,  Job Owner, Resource, Task Statuses (1 for Job Owner and 1 for Resource), Job Supervisor, Task Dates:1 set for Job Owner and 1 set for Resource (including: planned, called, due, estimated start, estimated complete, started, completed, accepted, alternate planned, booked ), Percentage Complete (1 for Job Owner and 1 for Resource) , Task Reference number (1 for Job Owner and 1 for Resource),

  • Job Not Ready: reason and comment
  • Alternate Date: proposed date, reason and comment
  • Rejection: reason and comment
  • Progress Updates: statuses, dates, percentage.
Notes

Retrieve a note by ID, create a note by job or task ID or by job number are all functions that can be undertaken using the Document API.

More specific note details provided include;

Description, Note Type, Job ID, Task ID, Date Created, Note Details, Owner, Recipient.

Documents

Retrieve a document by ID, create a document by job ID or task ID or job number are all functions that can be undertaken using the Document API.

More specific document content provided and information on how to obtain the document include:

Title, Job ID, Owner, Document Name, Extension, Reference No., Document Type, Date Uploaded, Path.

Purchase Orders (PO)

Get a PO list, Create or update a PO, get POs by id or reference, delete a PO by id or reference and attach a PO by reference are all functions that can be undertaken using the Document API.

More specific PO Details regarding Headers & Lines include;

Job ID, Resource, Job Supervisor, Requisition no., PO Reference, PO Date, Status, Approval Status, Total Price, Total Tax, Partial Payment, Quantity, Cost Code, Item Code, Description, UOM, Unit Price, Extended Price, Extended Tax.

Resource & Job Owner Details

Companies and individuals of both the Resource and Job Owner are referred to as organisations.

Retrieve organisation by ID or email address, create  or update organisation and remove organisation by ID are all functions that can be undertaken using the Organisation API.

More specific organisation details provided include;

name, mobile number, work number, fax number, job title, email address, address, logo.