Charge Code List

Returns the list of charge codes.

Charge Code List

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areatspending.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=chargecodelist
ClientNoFilter by client codecAPI_Client=1/1244
JobNoFilter by job numbercAPI_Job=1/00008321
Job PhaseNoFilter by job and phasecAPI_JobPhase=1/00008321.001
WorkflowNoFilter by workflow codecAPI_Workflow=1/W123
Task DescriptionNoFilter by task description codecAPI_TaskDesc=1/TD1
Phase TypeNoFilter by phase typecAPI_PhaseType=1/PT1
Activity TypeNoFilter by activity typecAPI_ActivityType=1/AT1
SearchNoFree-text searchcAPI_Search=design

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/tspending.json?&version=6&action=chargecodelist&company=1

Example request (legacy username/password):

http://<SERVER>/jsonapi/tspending.json?&version=6&action=chargecodelist&company=1&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 67,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "chargecodeUuid": "8D4431FCE252674686DA4DCD3EEEFB94",
      "chargecodeTimestampModified": 1594797067,
      "chargecodeRecordversionnumber": 1,
      "chargecodeActivityCode": "",
      "chargecodeChargecode": "1/33&44",
      "chargecodeDescription": "33&44",
      "chargecodeUserDefault": false
    },
    {
      "chargecodeUuid": "BEE4CB9403261845B2A23F06B16EFD1C",
      "chargecodeTimestampModified": 1594797073,
      "chargecodeRecordversionnumber": 11,
      "chargecodeActivityCode": "",
      "chargecodeChargecode": "1/AA",
      "chargecodeDescription": "aa",
      "chargecodeUserDefault": false
    }
  ]
}