Client financials

Clients

If you wish to access client financial settings data use the clientfinancial model

For more details about using models see Using data models

For clients two models are available:

clientslist
clientdetails
clientfinancial

Parameter	Description	Example	More info
API	The API area	clients.json
Action	Not required
General	Parameters described in overview	user=user&password=user	Overview
Company	Company number	company=1
Modelstructure	Name of model required	Modelstructure=clientfinancial	Using data models
Client	Specify client	client=1/P0909
Response	Returned data	A JSON string containing the data

Example request:

http://&lt;SERVER&gt;/jsonapi/clients.json?company=1&version=3.3&user=user&password=user&company=1&style=modeldata&modelstructure=clientfinancial&client=26/C0127

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientUuid": "CA1D229D72D8EB47A659669DD39FE48D",
      "clientTimeStampModified": 1554299566,
      "clientRecordVersionNumber": 16,
      "clientChargeTypeDescription": "Quote",
      "clientInvestment": 0,
      "clientTurnover": 0,
      "clientJobPhaseStatus": "Company Default",
      "clientTaxCodeDescripton": "1 (20%)",
      "clientCode": "26/C0127",
      "clientName": "Amazon",
      "clientMultiCurrency": true,
      "clientNominal": "",
      "clientNominalPurchase": "",
      "clientEbillingRef": "",
      "clientODCreditLimit": 0,
      "clientPaymentTermsDescription": "Immediate",
      "clientPaymentTermsInternal": 3,
      "clientPOMarkUp": true,
      "clientPOMarkUpPercent": 100,
      "clientPostingAccount": "",
      "clientChargeType": true,
      "clientCurrencycode": "",
      "clientCurrency": "- Base currency -",
      "clientInvestmentOpenBal": 0,
      "clientJobPrefix": "",
      "clientVatReg": "4344333",
      "clientTaxCode": 1,
      "clientTaxRate": 20,
      "clientDefaultStatus": 0
    }
  ]
}

Note: needs 12.2 for custom fields