JC Job
URL | Verbs | Function |
|---|---|---|
JCJob | GET | Query a list of JC Jobs |
| JCJob | POST | Create a new JC Job |
JCJob/<code> | GET | Query a single JC Job |
| JCJob/<code> | POST | Update a single JC Job |
Supported modifiers
Query String | Definition | Sample | Available |
|---|---|---|---|
| modifiedSince | Return JC Jobs modified since a particular date and time | modifiedSince=2013-02-28T16:45:00 | |
| treeName and treeBranch | Return a list of JC Jobs assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | |
| customer | Return a list of JC Jobs for a particular Customer | customer=A01112 | |
| accountManager | Return a list of JC Jobs for a particular Account Manager | accountManager=JT00002 | |
| jobManager | Return a list of JC Jobs for a particular Job Manager | jobManager=JT00345 | |
| parentJob | Return a list of JC Jobs for a particular parent job | parentJob=ABC0001 | |
| jobType | Return a list of JC Jobs for a particular Job Type | jobType=SERV | |
| isRecursive | Used in conjunction with parentJob to return a recursive list of child jobs for a parent job | parentJob=ABC0001&isRecursive=true | |
| includeSubJobs | Each Job that is found will output its hierarchy of sub jobs | includeSubJobs=true | |
| excludeClosed | Do not return any JC Jobs that are Closed | excludeClosed=true | 2017.1.0 |
| excludeFinalised | Do not return any JC Jobs that are Finalised | excludeFinalised=true | 2017.1.0 |
| isOpen | Only return JC Jobs that are NOT Closed or Finalised | isOpen=true | 2017.1.0 |
| isPlantOnly | Only return JC Jobs that are Plant | isPlantOnly=true | 2017.3.0 |
| profitCentre | Only return JC Jobs for the nominated Profit Centre | profitCentre=0303 | 2021.1 |
| template | Used on POST to prefill JC Job defaults from the nominated Template, values overridden by content of POST | template=Service | 2021.3 |
| workCentreAssignedEmployee | Return a list of JC Jobs that the Employee has been given access to a Work Centre Branch | workCentreAssignedEmployee=COOKC | 2023.1 |
Security Linked Menu
Menu Item | Located |
|---|---|
| Job Maintenance | Data Entry / Job Cost |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<JCJob>
<Edition>6</Edition>
<OidString>3317.108</OidString>
<Code>5000</Code>
<Name>System for Kangan</Name>
<ClientReference>KAG1223</ClientReference>
<Notes>System for Kangan - - see Kagen file for copy on contract # 566688</Notes>
<OrderNumber>005523</OrderNumber>
<IsActive>false</IsActive>
<IsClosed>false</IsClosed>
<IsFinalised>false</IsFinalised>
<Value>50000.00</Value>
<IsAdministration>false</IsAdministration>
<JobReference>566688</JobReference>
<QuoteReference>Q0055698</QuoteReference>
<CreateDate>2011-01-06</CreateDate>
<QuoteDate>2017-05-12</QuoteDate>
<AcceptDate>2017-05-13</AcceptDate>
<StartDate>2011-01-01</StartDate>
<Status>2. Active</Status>
<InvoiceReportFormat>Invoice Short Format</InvoiceReportFormat>
<IsProject>true</IsProject>
<IsTemplate>false</IsTemplate>
<IsMultipleDebtor>false</IsMultipleDebtor>
<IsUseWorkCentrePlan>false</IsUseWorkCentrePlan>
<Calendar>JUN</Calendar>
<SiteAddress>
<Contact>Peter</Contact>
<Address1>Lot 2, Main Hwy</Address1>
<Address2/>
<Address3>MacGregor</Address3>
<Suburb>CANTERBURY</Suburb>
<Postcode>4402</Postcode>
<State>VIC</State>
<TZone/>
<PhoneBH>(03) 9878 2343434</PhoneBH>
<PhoneAH/>
<Fax>(04) 5343</Fax>
<Email>email@work.com</Email>
<Web/>
<Mobile>0411 434 34545454</Mobile>
<AddressName>Field Office</AddressName>
</SiteAddress>
<DeliveryAddress>
<AddressNumber>1</AddressNumber>
<IsPrimaryAddress>false</IsPrimaryAddress>
<IsActive>true</IsActive>
<RunNumber>10</RunNumber>
<DropSequence>20</DropSequence>
<Instructions/>
<Contact>Des Stanley</Contact>
<Address1>(Rear Door) via lane</Address1>
<Address2>Lot 2, Main Hwy</Address2>
<Address3>MacGregor</Address3>
<Suburb/>
<Postcode>3125</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(03) 8425 1213</PhoneBH>
<PhoneAH/>
<Fax/>
<Email/>
<Web/>
<Mobile/>
</DeliveryAddress>
<IsAutoBalanceNegativeInvoices>false</IsAutoBalanceNegativeInvoices>
<IsUsingEstimateVariations>true</IsUsingEstimateVariations>
<ExpectedEndDate>2017-05-28</ExpectedEndDate>
<RevenueRecognitionCalculator>Job Value</RevenueRecognitionCalculator>
<PercentCompleteCalculator>Budget vs Actual - Hours</PercentCompleteCalculator>
<RevenueRecognitionProrata>Estimate</RevenueRecognitionProrata>
<RevenueRecognitionGLAccount>10.10.1030</RevenueRecognitionGLAccount>
<RevenueSalesGLAccount>10.10.1050</RevenueSalesGLAccount>
<EntryTimeStamp>2017-05-06T15:16:20</EntryTimeStamp>
<ModifiedTimeStamp>2017-05-06T16:16:45</ModifiedTimeStamp>
<JobType>SYS</JobType>
<ProfitCentre>0303</ProfitCentre>
<AccountManager>COOKC</AccountManager>
<JobManager>CORKC1</JobManager>
<ChargeType>FP</ChargeType>
<PriceCode>KANGAN</PriceCode>
<Customer>1000</Customer> <CustomerName>Kangan Education Unit</CustomerName>
<ActivityGroup>Labour Assembly</ActivityGroup>
<UserDefinedFields collection='true' count='5'>
<UserDefinedField>
<Name>Date Commensed</Name>
<Type>Date</Type>
<Value>2011-01-06</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Expected Completion Date</Name>
<Type>Date</Type>
<Value>2011-06-30</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Internal Contact</Name>
<Type>String</Type>
<Value>Brad Jones</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Job Duration - Days</Name>
<Type>Integer</Type>
<Value>120</Value>
</UserDefinedField>
<UserDefinedField>
<Name>Maintenance Paid</Name>
<Type>Boolean</Type>
<Value>true</Value>
</UserDefinedField>
</UserDefinedFields>
<Trees collection='true' count='1'>
<Tree>
<Name>Colour-AUS</Name>
<IsMandatory>false</IsMandatory>
<Value>Green</Value>
<Path>Green</Path>
<ShortCode>GREEN</ShortCode>
</Tree>
</Trees>
</JCJob>