Costs and Charges

List cost transactions against a phase

Costs and Charges

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaphases.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=costscharges
Job phaseYesJob and phase numberjobphase=1/00000519.001

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/phases.json?jobphase=1/00000519.001&&version=6&action=costscharges

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/phases.json?jobphase=1/00000519.001&&version=6&action=costscharges&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 26,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "costCharge": 0,
      "costChargeRate": 0,
      "costChargeRateOT1": 0,
      "costChargeRateOT2": 0,
      "costChargeCode": "1/TRA",
      "costCostRate": 0,
      "costCostRateOT1": 0,
      "costCostRateOT2": 0,
      "costCostTotal": 0,
      "costCurrencyBuy": "",
      "costCurrencyBuyDescription": "",
      "costCurrencyBuyRate": 1,
      "costCurrencyCharge": 0,
      "costCurrencyChargeRate": 0,
      "costCurrencyChargeRateNormal": 0,
      "costCurrencyChargeRateOT1": 0,
      "costCurrencyChargeRateOT2": 0,
      "costCurrencyRecommendedCharge": 0,
      "costCurrencyRecommendedChargeOT1": 0,
      "costCurrencyRecommendedChargeOT2": 0,
      "costCurrencySell": "1/EUR",
      "costCurrencySellDescription": "Euro",
      "costCurrencySellRate": 1.21,
      "costDate": "2016-10-19",
      "costDescription": "Employee Training",
      "costWorkDone": "",
      "costResourceName": "Michael Irving",
      "costQuantity": 15,
      "costQuantityOT1": 0,
      "costQuantityOT2": 0,
      "costRecommendedCharge": 0,
      "costRecommendedChargeOT1": 0,
      "costRecommendedChargeOT2": 0,
      "costTaskDescription": "",
      "costChargeCodeType": "T",
      "costStage": ""
    }
  ]
}