List supplier financial details
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | suppliers.json | |
General | Yes | Parameters described in overview | see overview | Structure of an API call |
Model Structure | Yes | Name of model required | modelstructure=supplierfinancial | Using data models |
View | No | Stored filter applied | Using views | |
Sort | No | Change the view's default sort order | sort=SUPPLIER | Sorting |
Filters | No | Filter by a key field | Filters | |
Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/suppliers.json?company=1&version=3.9&user=user&password=user&company=1&modelstructure=supplierfinancial
Example response:
Note:
supplierSettingsObject will either return a null value or a set of settings fields, These settings fields will only be returned if they have had their value explicitly set.
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 229,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"supplieruuid": "6630AB400A50714ABC8F7947A828ED6F",
"supplierTimeStampModified": 1603367508,
"supplierRecordVersionNumber": 40,
"supplierCode": "1/56",
"supplierName": "The Big Printing Company EURO",
"supplierExpense": true,
"supplierInactive": false,
"supplierGeneric": false,
"supplierOnHold": false,
"supplierProspect": false,
"supplierVatCode": 1,
"supplierVatRate": 20,
"supplierMarkup": 1,
"supplierDaysCredit": 0,
"supplierMultiCurrency": true,
"supplierCurrencyCode": "1/EUR",
"supplierCurrency": "Euro",
"supplierPostingAccount": "",
"supplierCategory": "",
"supplierNominalCode": "",
"supplierNominalInternal": "",
"supplierCreditorControl": "",
"supplierNotes": "",
"supplierSettingsObject": {
"PostExpensesInDefaultCurrency": false
}
},