| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | purchases.json | |
| General | Yes | Parameters described in overview | See overview | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=purchaseinvoicedetails | Using data models |
| View | No | Stored filter applied | Using views | |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=16 |
Example request:
http://<SERVER>/jsonapi/purchaseinvoices.json?user=user&password=user&version=3.9&modelstructure=purchaseinvoicedetails&company=16&view=46106
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
},