Purchase Invoice Details

Purchase Invoice Details

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areapurchaseinvoices.json
GeneralYesParameters described in overviewSee overviewStructure of an API call
Model StructureYesName of model requiredmodelstructure=purchaseinvoicedetailsUsing data models
ViewNoStored filter appliedUsing views
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=16

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/purchaseinvoices.json?&version=6&modelstructure=purchaseinvoicedetails&company=16&view=46106

Example request (legacy username/password):

http://<SERVER>/jsonapi/purchaseinvoices.json?&version=6&modelstructure=purchaseinvoicedetails&company=16&view=46106&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "pinvUuid": "FBCEAC5E03D64F2787DC5B763BB9B139",
      "pinvTimestampModified": 1637688143,
      "pinvRecordVersionNumber": 23,
      "pinvInvoiceNo": "16/1600024",
      "pinvSupplierCode": "16/JQ",
      "pinvSupplierName": "Jenna Quinn",
      "pinvDocumentDate": "2012-07-03",
      "pinvInvPostingDate": "2012-07-03",
      "pinvDateDue": "2012-07-03",
      "pinvDateCreated": "2012-07-03",
      "pinvTheirRef": "",
      "pinvGross": 50,
      "pinvVat": 0,
      "pinvCurrencyGross": 50,
      "pinvCurrencyTax": 0,
      "pinvNet": 50,
      "pinvCurrencyNet": 50,
      "pinvAllocated": 50,
      "pinvCurrencyAlloc": 50,
      "pinvUnallocated": 0,
      "pinvCurrencyUnAlloc": 0,
      "pinvCurrencyCode": "",
      "pinvExchangeRates": "",
      "pinvNotes": "",
      "pinvAuthoriserUserid": 0,
      "pinvAuthorised": "",
      "pinvAuthoriser": "",
      "pinvAuthorisedUserid": 0
    }
  ]
}