Parameter	Optional	Description
Queue	✓	Set 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.
SubmitRefId	✓	A 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.

Attribute	Type	Required	Description
accountMgr	object		See the accountMgr section below.
branch	string		The branch code. Branches must be enabled.
calcPricesFromTaxPaid	boolean		Default is according Tools->Options Job, Calc Tax Total From.
comments	array of object		See the comments section below.
custom	any		A free-form JSON object carrying additional data for custom processing. Used where custom processing is required and additional data must be passed to that custom processing.
customer	object	✓	The customer the quote is for. See the customer section below.
custRefNo	string		The customer's reference for the quote.
dateRequired	string		The date due for the new Quote. Must be in ISO date format - eg "2020-01-31"
dateValid	string		The date the Quote is valid till. Must be in ISO date format - eg "2020-01-31"
faultDesc	string		The fault description.
footer	string		Free-text footer shown at the bottom of the quote.
from	object		See the from section below.
glDept	string		The GL department code. GL departments must be enabled.
header	string		Free-text header shown at the top of the quote.
invoiceDesc	string		The description shown on the invoice.
itemCode	string		The item code.
itemDesc	string		The item description.
ourRef	string		Our reference for the quote.
paysTax	boolean		Flag to indicate if the customer is to pay GST. Should normally be left to default (set by customer CardFile)
probability	string		The probability (as a percentage) of winning the quote.
projectCode	string		The code of the project (contract) to associate the quote with.
quoteType	string		The Quote type. If omitted the Quote type will be Normal. Can be set to Back Order or TASK.
serialNo	string		The item's serial number.
shipAddress	object		See the shipAddress section below.
shipAttn	string		The ship-to contact (attention) name.
shipEmail	string		The ship-to contact email address.
shipPhone	string		The ship-to contact phone number.
shipTo	object		See the shipTo section below.
shipVia	string		The carrier or method the goods are shipped via.
status	string		The status for the Quote. This status must be valid per workflow from Booked.
stockLines	array of object		See the stockLines section below.
subBranch	string		The sub-branch code. Sub-branches must be enabled. Note that in the UI sub-branches may be renamed.
submitRefID	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.

Attribute	Type	Required	Description
cardCode	string		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
cardNo	integer		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).

Attribute	Type	Required	Description
comment	string	✓	The comment text.

Attribute	Type	Required	Description
cardCode	string		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
cardNo	integer		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).

Attribute	Type	Required	Description
cardCode	string		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
cardNo	integer		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).

Attribute	Type	Description
addressLine1	string	The ship-to street address. Multiple lines can be included, separated by new lines.
addressLine2	string	An optional second line of the ship-to street address (see addressLine1).
country	string	The ship-to country.
customerName	string	customer name as first line.
isAddressResidential	boolean	is this a residential address?
postcode	string	The ship-to post code.
state	string	The ship-to state.
suburb	string	The ship-to suburb.

Attribute	Type	Required	Description
cardCode	string		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).
cardNo	integer		cardCode or cardNo are required. If both are supplied that must be consitent with each other (ie match what is stored within Jim2).

Attribute	Type	Required	Description
qty	number	✓	The quantity of the stock to add to the quote.
recommend	boolean		Default is true. Indicates if this stock line is to be ticked as recommended.
stockCode	string	✓	The Jim2 stock code (the Jim2 user is buying the stock)
stockDescription	string		The stock description. Only required if the default stock description needs to be overridden. It is recommended this be set for special stock.
unitPriceTF	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.
unitPriceTP	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.
unitQty	number		The number of base units contained in each unit of measure (eg 12 for a box of 12). If omitted, 1 is used.

Attribute	Type	Description
quoteNo	integer	The number of the created quote.

{
    "submitRefID": "QUOTE-REQ-0001",
    "quoteType": "Normal",
    "customer": {
        "cardCode": "CUST.1"
    },
    "shipTo": {
        "cardCode": "CUST.1"
    },
    "from": {
        "cardCode": "CUST.1"
    },
    "dateRequired": "2026-07-15",
    "dateValid": "2026-07-31",
    "status": "Booked",
    "accountMgr": {
        "cardCode": "STAFF.AM"
    },
    "branch": "SYD",
    "subBranch": "SYD-NORTH",
    "glDept": "SALES",
    "probability": "50",
    "custRefNo": "PO-44821",
    "ourRef": "QUOTE-REF-01",
    "serialNo": "SN-12345",
    "shipAttn": "Receiving Dock",
    "shipAddress": {
        "customerName": "Acme Corporation Pty Ltd",
        "isAddressResidential": false,
        "addressLine1": "12 Industrial Ave",
        "addressLine2": "Building B",
        "suburb": "Chatswood",
        "state": "NSW",
        "postcode": "2067",
        "country": "Australia"
    },
    "shipVia": "Courier Express",
    "shipPhone": "02 9999 0000",
    "shipEmail": "dispatch@acme.example",
    "projectCode": "PRJ-001",
    "paysTax": true,
    "calcPricesFromTaxPaid": false,
    "itemCode": "WIDGET-1",
    "itemDesc": "Widget assembly",
    "faultDesc": "Quote for replacement unit.",
    "invoiceDesc": "Supply and fit widget assembly.",
    "header": "Thank you for your enquiry.",
    "footer": "Prices valid for 30 days.",
    "comments": [
        {
            "comment": "Initial quote note."
        }
    ],
    "stockLines": [
        {
            "stockCode": "WIDGET-1",
            "stockDescription": "Widget assembly (special)",
            "unitQty": 1,
            "qty": 2,
            "unitPriceTF": 100.00,
            "recommend": true
        }
    ],
    "custom": {
        "externalRef": "EXT-12345"
    }
}

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

api/v1/quotecreate

accountMgr

comments

customer

from

shipAddress

shipTo

stockLines