Returns financial totals for each job
Job Financials
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | jobs.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=jobfinancial | 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 | |
| Identifier | Yes | Job ID or UUID | job=1/00000510 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/jobs.json?&company=1&modelstructure=jobfinancial&job=1/00000510&version=6Example request (legacy username/password):
http://<SERVER>/jsonapi/jobs.json?&company=1&modelstructure=jobfinancial&job=1/00000510&version=6&user=<username>&password=<password>Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"jobUuid": "57F47F438D6A49489FD50D25BFC4509E",
"jobTimeStampModified": 1591871500,
"jobRecommendedVersionNumber": 334,
"jobNumber": "1/00000510",
"jobBaselineTotalEstimateCost": 480,
"jobBillingPlanProjectCost": 0,
"jobBillingPlanTotalCostAvailable": 0,
"jobCostTotal": 2676,
"jobCostTotalPI": 2176,
"jobCostTotalPopi": 2676,
"jobPercentageActualBaseCost": 557.5,
"jobPercentageActualEstimateCost": 63.532763532764,
"jobBaselineTotalEstimateMaterialsCost": 0,
"jobMaterialsCostTotal": 12,
"jobPercentageActualBaseCostMaterials": 0,
"jobPercentageActualEstimateCostMaterials": 240,
"jobBaselineTotalEstimatePOCost": 0,
"jobPICost": 1200,
"jobPOCostPI": 1700,
"jobPOCostTotal": 1700,
"jobPercentageActualBaseCostPO": 0,
"jobPercentageActualEstimateCostPO": 100,
"jobBaselineTotalEstimateTimeCost": 480,
"jobTimeCostTotal": 964,
"jobPercentageActualBaseCostTime": 200.83333333333,
"jobPercentageActualEstimateCostTime": 38.452333466294,
"jobBaselineTotalEstimateHours": 24,
"jobActualUnitsBase": 49,
"jobActualUnitsNormal": 49,
"jobActualUnitsOT1": 0,
"jobActualUnitsOT2": 0,
"jobEstimateUnitsBase": 126,
"jobPercentageActualBaseNormal": 204.16666666667,
"jobPercentageActualBaseUnits": 204.16666666667,
"jobPercentageActualEstimateNormal": 38.888888888889,
"jobPercentageActualEstimateUnits": 38.888888888889,
"jobBaselineTotalEstimateChargeOut": 0,
"jobBaselineTotalEstimateMaterialsCharge": 0,
"jobBaselineTotalEstimatePOCharge": 0,
"jobBaselineTotalEstimateTimeCharge": 0,
"jobBillingPlanTargetProfitPercentage": 0,
"jobChargeTotal": 1129.48,
"jobCurChargeTotal": 508.25,
"jobCurQuotedPrice": 0,
"jobEstimateTotal": 4212,
"jobGrossMargin": -1700,
"jobGrossMarginWeighted": -1700,
"jobInvestmentTotal": -8944,
"jobInvoicedTotal": 17154,
"jobMaterialsChargeTotal": 71.12,
"jobMaterialsCurCharge": 32,
"jobMaterialsEstimateTotal": 5,
"jobMaterialsEstimateChargeOut": 361.11,
"jobNetMargin": -4212,
"jobNetMarginWeighted": -4212,
"jobPOChargeTotal": 0,
"jobPOCurCharge": 0,
"jobPOEstimateTotal": 1700,
"jobPOEstimateChargeOut": 1399.99,
"jobQuotedPrice": 0,
"jobQuotedPriceWeighted": 0,
"jobTimeChargeTotal": 1058.36,
"jobTimeCurCharge": 476.25,
"jobTimeEstimateTotal": 2507,
"jobTimeEstimateChargeOut": 280,
"jobPercentageActualBaseCharge": 0,
"jobPercentageActualBaseChargeMaterials": 0,
"jobPercentageActualBaseChargePO": 0,
"jobPercentageActualBaseChargeTime": 0,
"jobPercentageActualEstimateCharge": 55.336828180883,
"jobPercentageActualEstimateChargeMaterials": 19.694829830246,
"jobPercentageActualEstimateChargePO": 0,
"jobPercentageActualEstimateChargeTime": 377.98571428571,
"jobPercentageChargeQuote": 0,
"jobPercentageEstimateQuote": 0,
"jobPercentageInvQuote": 0,
"jobPercentageRecommendedChargeInvoiced": 6.584353503556,
"jobRecognisedTotal": 17154,
"jobPercentageRecognisedInvoiced": 100,
"jobPercentageRecognisedQuoted": 0
}
]
}