Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Get Job Financials

Use this endpoint to get the Financials for the specified job. Supported includes: worksheet, amendments.

get/jobs/{jobId}/financials

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

includes'amendments' | 'worksheet' | 'amendments worksheet'

Optional fields to include in full with the response

Response

OK

idstring uuid

The unique identifier of the Financials.

_linkstring

The unique URI of the Financials for the specified Job.

jobIdstring uuid

The unique identifier of the Job these financials are for.

approvedJobValuenumber

The current approved Job Value.

balanceDuenumber

The current amount still owed on the job.

Example response

{
  "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "_link": "https://api.acculynx.com/api/v2/jobs/01a7cfc1-2231-4589-9657-7f3004c06bd3/financials",
  "jobId": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "approvedJobValue": 123.45,
  "balanceDue": 123.45,
  "worksheetSectionTotals": {
    "worksheetTotal": 123.45,
    "changeOrderTotal": 123.45,
    "insuranceClaimTotal": 123.45,
    "upgradeTotal": 123.45,
    "discountTotal": 123.45,
    "supplementTotal": 123.45,
    "workNotDoingTotal": 123.45
  },
  "worksheet": [
    {
      "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
      "_link": "https://api.acculynx.com/api/v2/financials/01a7cfc1-2231-4589-9657-7f3004c06bd3/worksheet"
    }
  ],
  "amendments": [
    {
      "id": "bf840f50-8a19-45d6-b6e8-86ad5db500af",
      "_link": "https://api.acculynx.com/api/v2/financials/01a7cfc1-2231-4589-9657-7f3004c06bd3/amendments/bf840f50-8a19-45d6-b6e8-86ad5db500af"
    }
  ]
}