Purchase Details

Retrieve details of a purchase order

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areapurchases.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
Model StructureYesName of model requiredmodelstructure=purchaseorderdetailsUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CREATEDSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
IdentifierYesPurchase ID or UUIDpurchase=10006576

Example request:

http://<SERVER>/jsonapi/purchases.json?modelstructure=purchaseorderdetails&user=user&password=user&company=1&version=3.8&purchase=10006576

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "poUuid": "4243DA0B55EE484D8F2188EDE3857D3F",
      "poTimeStampModified": 1528804929,
      "poRecordVersionNumber": 5,
      "poSalesCodeDescription": "1 (20%)",
      "poClientCode": "1/JAMES",
      "poClientName": "James Projects",
      "poJobNumber": "1/00123",
      "poJobDescription": "ITG PR, marketing and comms",
      "poJobandPhase": "1/00123.004",
      "poPhaseDescription": "Purchasing",
      "poInternal": 10006576,
      "poTransferredFrom": "",
      "poDescription": "My purchase order ",
      "poTheirRef": "",
      "poPickedForQuote": true,
      "poPicked": true,
      "poInvest": false,
      "poDateOrdered": "2018-06-12",
      "poEstimatedDate": "2018-06-12",
      "poCost": 33,
      "poEstCost": 25,
      "poMarkup": 100,
      "poEstMarkUp": 100,
      "poCharge": 66,
      "poEstRecChgOut": 50,
      "poCurrencyEstCharge": 50,
      "poOriginalCost": 25,
      "poInvestment": 0,
      "poCancelDate": "0000-00-00",
      "poOrderText": "",
      "poInvoiceRcd": false,
      "poInvoiceRef": "",
      "poFinalPITheirRef": "",
      "poInvDocDate": "0000-00-00",
      "poInvoiceDate": "0000-00-00",
      "poSalesInvNo": "",
      "poTotalInvoiced": 0,
      "poNotes": "",
      "poTransferHistory": "",
      "poCurrencyRate": 1,
      "poCurrencyCost": 33,
      "poCurrencyEstCost": 25,
      "poCurrencyOrigCost": 25,
      "poCurrencyCharge": 66,
      "poCurrencyInvoiced": 0,
      "poTaxCode": 1,
      "poSalesTaxRate": 20,
      "poSupplierContactInternalRef": 0,
      "poContactName": "",
      "poOrderedByUserId": 628,
      "poOrderedByFullName": "James Smith",
      "poSupplytype": "1/PMX",
      "poSupplyTypeDescription": "Print",
      "poCurrencyCode": "",
      "poCurrency": "",
      "poPurchaseOrderType": "P",
      "poSupplierCode": "1/PR100",
      "poSupplierName": "Printing 100"
    }
  ]
}