Index

api/v1/quotecreate

Path: api/v1/quotecreate

Method:POST

Summary:Creates a new quote

Query Parameters:

QueueOptionalSet to true, 1, or t to queue the request via the Jim2 eBusiness Queue. If specified the response will be 202 Accepted and the B2B request number will be returned.
Leave out, or set to false, 0, or f to process the request immediately.
SubmitRefIdOptionalA unique reference ID for the request. This is used to prevent duplicate requests when the Queue parameter is also passed. If a SubmitRefId is passed via this query parameter and within the request content (see submitRefId in JSON content) then the two values must be the same. A check for duplication due to re-processing on the B2B queue is NOT performed unless the SubmitRefId is included in the request body (ie not passing the SubmitRefId in the message body allows an item on the B2B queue to be reprocessed and potentially creating a duplicate object).
The Queue parameter must also be specified if SubmitRefId is specified.
Note that the SubmitRefId must be unique to Jim2, so if multiple systems are making calls care must be taken to avoid clashes in SubmitRefIds between systems.

Request content:

{
The Quote type. If omitted the Quote type will be Normal. Can be set to Back Order or TASK.
optional
"quoteType":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 Quote. Must be in ISO date format - eg "2020-01-31"
optional
"dateRequired":string
"dateValid":string
The status for the Quote. This status must be valid per workflow from Booked.
optional
"status":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 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
"probability":string
optional
"custRefNo":string
optional
"ourRef":string
optional
"serialNo":string
optional
"shipAttn":string
optional
"shipAddress":{
customer name as first line.
optional
"customerName":string
is this a residential address?
optional
"isAddressResidential":boolean
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
optional
"projectCode":string
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
"faultDesc":string
optional
"invoiceDesc":string
optional
"header":string
optional
"footer":string
optional
"comments": [{
"comment":string
}]
"stockLines": [{
The Jim2 stock code (the Jim2 user is buying the stock)
"stockCode":string
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
Default is true. Indicates if this stock line is to be ticked as recommended.
optional
"recommend":boolean
}]
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
}

Response content:

{
"quoteNo":integer
}