The Job type. If omitted the Job type will be Normal.
optional
"jobType":string
"customer":{
cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
optional
"shipTo":{
cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
optional
"from":{
cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
The date due for the new Job. Must be in ISO date format - eg "2020-01-31"
optional
"dateDue":string
optional
"accountMgr":{
cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
The currency code the job is to be created in. Current exchange rate from Jim2 will be used.
optional
"currencyCode":string
The status for the Job. This status must be valid per workflow from Booked, and cannot be FINISH.
optional
"status":string
The branch code. Branches must be enabled.
optional
"branch":string
The sub-branch code. Sub-branches must be enabled. Note that in the UI sub-branches may be renamed.
optional
"subBranch":string
The GL department code. GL departments must be enabled.
optional
"glDept":string
optional
"custRefNo":string
optional
"ourRef":string
optional
"shipAttn":string
optional
"shipAddress":{
customer name as first line.
optional
"customerName":string
is this a residential address?
optional
"isAddressResidential":boolean
Note, it is not required to split street address lines, you can specify multiple address lines in addressLine1. If you have an address that goes over more than two lines then you can:
- include all lines in addressLine1 - seperated by new lines
- put the first line (eg suite/level) into addressLine1 and the remaining lines into addressLine2 using a new line as seperator
optional
"addressLine1":string
optional
"addressLine2":string
optional
"suburb":string
optional
"state":string
optional
"postcode":string
optional
"country":string
}
optional
"shipVia":string
optional
"shipPhone":string
optional
"shipEmail":string
Deprecated. Use project->code. This may be removed from future versions of Jim2.
optional
"projectCode":string
Fill out the project object (one or more name/value pairs) to associate the job with an asset.
optional
"project":{
If supplied used to detemine the project the created job will be linked to. If code provided they must both match the same project or the transaction will fail.
optional
"projectNo":integer
If supplied used to detemine the project the created job will be linked to. If projectNo provided they must both match the same project or the transaction will fail.
optional
"code":string
}
Fill out the asset object (one or more name/value pairs) to associate the job with an asset.
optional
"asset":{
If supplied used to detemine the asset the created job will be linked to. If code and serial provided they must both match the same asset or the transaction will fail.
optional
"assetNo":integer
If supplied used to detemine the asset the created job will be linked to. If assetNo and serial provided they must both match the same asset or the transaction will fail.
optional
"code":string
If supplied used to detemine the asset the created job will be linked to. If assetNo and code provided they must both match the same asset or the transaction will fail.
optional
"serial":string
If supplied used to detemine the asset the created job will be linked to. If set to true and assetNo, code, or serial provided they must both match the asset linked to the project or the transaction will fail.
optional
"useProjectAsset":boolean
}
Flag to indicate if the customer is to pay GST. Should normally be left to default (set by customer CardFile)
optional
"paysTax":boolean
Default is according Tools->Options Job, Calc Tax Total From.
optional
"calcPricesFromTaxPaid":boolean
optional
"itemCode":string
optional
"itemDesc":string
optional
"itemSerialNo":string
optional
"faultDesc":string
optional
"invoiceDesc":string
optional
"comments": [{
}]
"stockLines": [{
The Jim2 stock code
"stockCode":string
The stock description. Only required if the default stock description needs to be overrridden. It is recommended this be set for special stock.
optional
"stockDescription":string
optional
"unitQty":number
"qty":number
The price ex. If no price is required then Jim2's default Job pricing will be used. However, only one of unitPriceTF or unitPriceTP can be provided. It is recommended to specify unitPriceTP if calcPriceFromTaxPaid is true.
optional
"unitPriceTF":number
The price inc. If no price is required then Jim2's default Job pricing will be used. However, only one of PriceTF or PriceTP can be provided.It is recommended to specify unitPriceTF if calcPriceFromTaxPaid is false.
optional
"unitPriceTP":number
The location from which the stock is to be sold. Normally this field is left out.
optional
"location":string
}]
A unique reference for the create request. This reference must be unique for each object and can be used to ensure duplicate objects are not created when re-trying API calls. Note this reference must be unique in Jim2, so if multiple systems are creating objects care must be taken to avoid clashes between the different system's submit ref id. Refer also to the SubmitRefId url query parameter for relevant endpoints.
optional
"submitRefID":string
Used where custom processing is required and additional data must be passed to that custom processing.
optional
"custom":any