The Jobs endpoint supports GET, PUT and POST.

The purpose is to allow you to access job details from Streamtime and also create new jobs. You could develop a job detail tool similar to our Client Web App or make a briefing webpage which creates a job.

The fields available as criteria in the API Previewer on the Jobs endpoint for a GET are - 

'UID'
'JobNumber'
'Name'
'Status'
'Details'
'AccountManager'
'JobOwners'
'OrderNumber'
'DateIn'
'DateDue'
'PricingTierUID'
'WIP' (known as 'Active' in Streamtime)

Job UID: is the unique identifier for the job but the job UID and job number will not necessarily be the same. You can do a GET to find out Job UID's. In general, its best to use one or the other when updating job records via the API.

<Job>
    <UID>1141</UID>
    <JobNumber>2028</JobNumber>
</Job>

Job Number: as seen in the Streamtime interface.

When doing a PUT/POST for a new job, provide your own Job Number (make sure it is unique) or leave blank to have the API provide a job number. The job number will be given the next incremental Custom Number. If your Streamtime setup uses a Job Number Format other than "Custom Number", you may want to modify the Job Number field after creation, to match your desired format.

Job Name:  as seen in the Streamtime interface.

Job Status: can be viewed when doing a GET and can be added. As with quotes a list of available job statuses (from Setup - System Setup - Jobs - Active Job Definitions - Master List) is not available as a GET from the Streamtime API so these will need to be hard coded into any job creation application.

Client UID: is the client company ID. The UID is not visible in the Streamtime interface but can found by doing a GET from the Contacts endpoint.

Client Name: of the related client company. This is visible in the Streamtime interface.

Person UID: is the key contact from the related client company on the job. This is the UID and is not visible in the Streamtime interface. Use either Person UID or Person Name when updating or creating job records.

Person Name: of the related key contact from the client company on the job. This is visible in the Streamtime interface.

Price Tier UID: is the Pricing tier the client is on and which relates to the job. For more on price tiers see the Products endpoint detail.

Active: allows you to GET active or inactive jobs (formally known as WIP.)

Account Manager: is the client manager as visible on the Streamtime interface. This a Streamtime user. A list of Streamtime users are not available as a GET so when creating a job you would ideally leave this blank and assign through the Streamtime interface or hard code.

Order Number: is a text field and populates the Order No field in the Streamtime interface. It is for a client PO number. This should be the same as on any related quote although you can only have 1 on a job so if there are multiple quotes with multiple orders you have to choose only 1 order number for the job or make it a composite number e.g. 1001/1003/1005.

Date In: is the date the job was created.

Date Due: is the over all job due date.

Job Billable is also available in the search criteria and will be returned when doing a GET but only if your running Streamtime 13v5 or later. If you do a GET in the previewer or in your code and use the billable criteria and you have an older version of Streamtime then you will receive the following error -

{
    "Result": "Error",
    "Message": "Field is missing"
}

Get in touch to upgrade your Streamtime to access the additional criteria.

The minimum fields you must use to create a job are Client UID or Name, and Job Name. Status and Date In will get set automatically if not provided.

<Jobs>
    <Job>
        <Name>Test Job</Name>
        <Client>
            <UID>1234</UID>
        </Client>
    </Job>
</Jobs>

 

The full list of fields returned when doing a GET are -

'UID'
'JobNumber'
'Name'
'Status'
'Details'
'AccountManager'
'JobOwners'
'OrderNumber'
'DateIn'
'DateDue'
'PricingTierUID'
'WIP' (known as 'Active' in Streamtime)

Did this answer your question?