Returns financial totals for each phase
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | phases.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=phasefinancial | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/phases.json?user=user&password=user&company=1&modelstructure=phasefinancial&view=-1307&page=1&rows=2&version=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 45,
"totalpages": 23,
"responsemessage": "",
"pagerows": 2,
"pagenumber": 1,
"success": true,
"data": [
{
"phaseuuid": "366650887E8C5F4BA822E0F4870A3AED",
"phaseTimeStampModified": 1597853984,
"phaseRecordVersionNumber": 4,
"phaseJobAndPhase": "1/00000205.001",
"phaseBPTotalCostAvailable": 0,
"phaseCostTotal": 0,
"phaseCostTotalPI": 0,
"phaseCostTotalPOPI": 0,
"phasePercentActualBaseCost": 0,
"phasePercentActualEstimateCost": 0,
"phaseBaselineTotalEstimateMaterialsCost": 0,
"phaseMaterialsCostTotal": 0,
"phasePercentActualBaseCostMaterials": 0,
"phasePercentActualEstimateCostMaterials": 0,
"phaseBaselineTotalEstimatePOCost": 0,
"phasePICost": 0,
"phasePOCostPI": 0,
"phasePOCostTotal": 0,
"phasePercentActualBaseCostPO": 0,
"phasePercentActualEstimateCostPO": 0,
"phaseBaselineTotalEstimateTimeCost": 0,
"phaseTimeCostTotal": 0,
"phasePercentActualBaseCostTime": 0,
"phasePercentActualEstimateCostTime": 0,
"phaseBaselineTotalEstimateHours": 0,
"phaseActualUnitsBase": 0,
"phaseActualUnitsNormal": 0,
"phaseActualUnitsOT1": 0,
"phaseActualUnitsOT2": 0,
"phaseEstimateUnitsBase": 0,
"phasePercentActualBaseNormal": 0,
"phasePercentActualBaseUnits": 0,
"phasePercentActualEstimateNormal": 0,
"phasePercentActualEstimateUnits": 0,
"phaseChargeTotal": 0,
"phaseCurChargeTotal": 0,
"phaseCurQuotedPrice": 444,
"phaseEstimateTotal": 0,
"phaseGrossMargin": 444,
"phaseGrossMarginWeighted": 444,
"phaseInvestmentTotal": 0,
"phaseInvoicedTotal": 0,
"phaseMaterialsChargeTotal": 0,
"phaseMaterialsCurCharge": 0,
"phaseMaterialsEstimateTotal": 0,
"phaseMaterialsEstimateChargeOut": 0,
"phaseNetMargin": 444,
"phaseNetMarginWeighted": 444,
"phasePOChargeTotal": 0,
"phasePOCurCharge": 0,
"phasePOEstimateTotal": 0,
"phaseQuotedPrice": 444,
"phaseQuotedPriceWeighted": 444,
"phaseTimeChargeTotal": 0,
"phaseTimeCurCharge": 0,
"phaseTimeEstimateTotal": 0,
"phaseTimeEstimateChargeOut": 0,
"phasePercentActualBaseCharge": 0,
"phasePercentActualBaseChargeMaterials": 0,
"phasePercentActualBaseChargePO": 0,
"phasePercentActualBaseChargeTime": 0,
"phasePercentActualEstimateCharge": 0,
"phasePercentActualEstimateChargeMaterials": 0,
"phasePercentActualEstimateChargePO": 0,
"phasePercentActualEstimateChargeTime": 0,
"phasePercentChargeQuote": 0,
"phasePercentEstimateQuote": 0,
"phasePercentInvQuote": 0,
"phasePercentRecChargeInvoiced": 0,
"phaseRecognisedTotal": 0,
"phasePercentageRecognisedInvoiced": 0,
"phasePercentageRecognisedQuoted": 0
},