Supplier Financial Details

List supplier financial details

Supplier Financial Details

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areasuppliers.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
Model StructureYesName of model requiredmodelstructure=supplierfinancialUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=SUPPLIERSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/suppliers.json?company=1&version=6&&company=1&modelstructure=supplierfinancial

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/suppliers.json?company=1&version=6&&company=1&modelstructure=supplierfinancial&user=<username>&password=<password>

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
      }
    }
  ]
}