Purchase List

Returns one or more purchase orders

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areapurchases.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
Model StructureYesName of model requiredmodelstructure=purchaseorderlistUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CREATEDSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
Job/phaseNoFilter by job/phasejobphase =1/00001076.002

Example request:

http://<SERVER>/jsonapi/purchases.json?modelstructure=purchaseorderlist&user=user&password=user&company=1&version=3.8&jobphase=1/00001076.002

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 3407,
  "totalpages": 1704,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "poUuid": "AE38CED93A63472AA014D159DB8F41C3",
      "poTimeStampModified": 1520341389,
      "poRecordVersionNumber": 32,
      "poCostDisplay": "£200.00",
      "poInternal": 10000167,
      "poPONumber": "{EST}",
      "poDescription": "Subcontract Web Design",
      "poJobandPhase": "1/00000543.001",
      "poTheirRef": "Ref123123",
      "poOrderedByUserId": 242,
      "poOrderedByFullName": "Adele Graham",
      "poSupplytype": "1/PRI",
      "poSupplyTypeDescription": "Printers",
      "poSupplierName": "The Printing Shop",
      "poViewDate": "2002-05-30",
      "poEstimatedDate": "2002-05-30",
      "poInvoiceDate": "0000-00-00",
      "poDateCreated": "0000-00-00",
      "poDateSent": "0000-00-00",
      "poViewTime": "00:00:00",
      "poViewTimeZone": "",
      "poEstCost": 200,
      "poCost": 0,
      "poPurchaseOrderType": "P",
      "poSupplierCode": "1/PS1"
    },
    {
      "poUuid": "BA5C900B756E4363BEE26BF0239D34A2",
      "poTimeStampModified": 1385821179,
      "poRecordVersionNumber": 25,
      "poCostDisplay": "£244.00",
      "poInternal": 10000162,
      "poPONumber": "{EST}",
      "poDescription": "Printing Purchase",
      "poJobandPhase": "1/00000592.001",
      "poTheirRef": "",
      "poOrderedByUserId": 0,
      "poOrderedByFullName": "",
      "poSupplytype": "1/PRI",
      "poSupplyTypeDescription": "Printers",
      "poSupplierName": "Brilliant",
      "poViewDate": "2002-05-28",
      "poEstimatedDate": "2002-05-28",
      "poInvoiceDate": "2002-08-28",
      "poDateCreated": "0000-00-00",
      "poDateSent": "0000-00-00",
      "poViewTime": "00:00:00",
      "poViewTimeZone": "",
      "poEstCost": 244,
      "poCost": 0,
      "poPurchaseOrderType": "P",
      "poSupplierCode": "1/BRILLIAN"
    }
  ]
}