Index

api/v1/pocreate

Path: api/v1/pocreate

Method:POST

Summary:Creates a new purchase order

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 PO type. If omitted the PO type will be Purchase. Can be set to Purchase or Debtors PO.
optional
"poType":string
OBSOLETE: Use vendorInvNo instead.
optional
"buyerOrderNo":string
The vendor invoice # for PO Type Purchase. The customer invoice # for PO Type Debtors PO.
optional
"vendorInvNo":string
Default is according Tools->Options Purchase, Calc Tax Total From.
optional
"calcPricesFromTaxPaid":boolean
The company doing the purchasing. Only relevant for multi company databases.
optional
"buyer":{
The buyer's account number. If supplied must be consistent with the sellor cardCode or cardNo if either of those are also supplied. In Jim2 the buyer account number is stored on the vender cardfile. NB for multicompany, if the vendor account number is used a seperate vendor cardfile must be used for each company.
optional
"accountNo":string
cardCode or cardNo are required. If both are supplied that must be consistent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
"seller":{
cardCode or cardNo are required. If both are supplied that must be consistent 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 consistent 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 consistent with each other (ie match what is stored within Jim2).
optional
"cardNo":integer
optional
"cardCode":string
}
The date due for the new PO. Must be in ISO date format - eg "2020-01-31"
optional
"dateDue":string
"ourRef":string
The status for the PO. This status must be valid per workflow from Booked, and cannot be Received or FINISH.
optional
"status":string
optional
"bidReference":string
Set to true if the the order can be part shipped
optional
"allowPartShip":boolean
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
"notes":string
optional
"comments": [{
"comment":string
}]
"stockLines": [{
The Jim2 stock code (the Jim2 user is buying the stock)
"buyerStockCode":string
optional
"unitQty":number
"qty":number
The price ex. If no price is required then Jim2's default PO pricing will be used. However, only one of PriceTF or PriceTP can be provided.
optional
"unitPriceTF":number
The price inc. If no price is required then Jim2's default PO pricing will be used. However, only one of PriceTF or PriceTP can be provided. Note that if the customer is not paying tax this will be the equalent to specifying the same value in unitPriceTF
optional
"unitPriceTP":number
Discount percent.
optional
"discount":number
The location to which the stock is to be delivered. Normally this field is left out.
optional
"location":string
Only applicable to stock that is serial on purchase or serial on sell. An array of serial numbers (and possible attributes if stock is also attributed) related to this stock.
optional
"serials": [{
A stock serial number.
"serialNo":string
Only applicable to stock that is serial and attributed on purchase or serial on sell.
optional
"stockAttrs": [{
The attribute name.
"name":string
The attribute value. Note, this is always send as a string, but the attribute type dictates the acceptable string formats.
eg integer attributes values must be a whole number
date attribute values must be a date is ISO format
real attribute values must be a decimal string (with period as the decimal separator)checkbox values must be a boolan value ("true", or "false").
"value":string
}]
}]
Only applicable to stock that is attribute on purchase or attribute on sell. An array of attributes related to this stock.
optional
"stockAttrs": [{
The attribute name.
"name":string
The attribute value. Note, this is always send as a string, but the attribute type dictates the acceptable string formats.
eg integer attributes values must be a whole number
date attribute values must be a date is ISO format
real attribute values must be a decimal string (with period as the decimal separator)checkbox values must be a boolan value ("true", or "false").
"value":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
}

Response content:

{
"poNo":integer
}

Example POST

Request:

{
  "seller": {
    "cardCode": "VEND.1"
  },
  "shipTo": {
    "cardCode": "SYS"
  },
  "vendorInvNo": "Inv123",
  "status": "Booked",
  "dateDue": "2025-01-01",
  "comments": [
    {
      "comment": "first comment"
    },
    {
      "comment": "second comment line 1\r\nsecond comment line two"
    }
  ],
  "stockLines": [
    {
      "buyerStockCode": "MOUSE",
      "qty": 1.0,
      "unit": "UNIT",
      "unitPriceTP": 100,
      "serials": [
        {
          "serialNo": "serial11",
          "stockAttrs": [
            {
              "name": "Colour",
              "value": "R,Red"
            },
            {
              "name": "Size",
              "value": "8,Eight"
            }
          ]
        }
      ]
    }
  ]
}

Response:

{
    "poNo": 12
}

Generated from Jim2 version 4.6.9804.70