---
title: "Get Financials"
method: GET
path: "/financials/{financialsId}"
tags: ["financials"]
---

# Get Financials

`GET /financials/{financialsId}`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/financials/{financialsId}`
- Auth: HTTP bearer

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

## Path parameters

- `financialsId` string, uuid, required

## Query parameters

- `includes` 'amendments' | 'worksheet' | 'amendments worksheet'

## Response `200`

OK

- Financials
  - `id` string, uuid: The unique identifier of the Financials.
  - `_link` string: The unique URI of the Financials for the specified Job.
  - `jobId` string, uuid: The unique identifier of the Job these financials are for.
  - `approvedJobValue` number: The current approved Job Value.
  - `balanceDue` number: The current amount still owed on the job.
  - `worksheetSectionTotals` WorksheetSectionTotals
    - `worksheetTotal` number: The total of all worksheet sections across both the Worksheet and any Amendment(s).
    - `changeOrderTotal` number: The total of all change order sections across both the Worksheet and any Amendment(s).
    - `insuranceClaimTotal` number: The total of all insurance claim sections across both the Worksheet and any Amendment(s).
    - `upgradeTotal` number: The total of all upgrade sections across both the Worksheet and any Amendment(s).
    - `discountTotal` number: The total of all discount sections across both the Worksheet and any Amendment(s).
    - `supplementTotal` number: The total of all supplement sections across both the Worksheet and any Amendment(s).
    - `workNotDoingTotal` number: The total of all work not doing sections across both the Worksheet and any Amendment(s).
  - `worksheet` WorksheetLink[]: The Worksheet of the Job these financials are for.
    - `id` string, uuid: The unique identifier of the Worksheet.
    - `_link` string: The unique URI of the Worksheet for the specified Job.
  - `amendments` WorksheetAmendmentLink[]: The Amendments of the Job these financials are for.
    - `id` string, uuid: The unique identifier of the Amendment.
    - `_link` string: The unique URI of the Amendment.

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.

## Changes

- **2026-11-03** `443924b00f43`: 1 breaking
  - for the `query` request parameter `includes`, default value `` was removed

[Operation history](https://skmtc.dev/acculynx/apis/acculynx-api-v2/changes/financials/:financialsId/get.md)

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)