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

# Get Worksheet

`GET /financials/{financialsId}/worksheet`

## Request

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

Use this endpoint to get a specific Worksheet by financial ID.

## Path parameters

- `financialsId` string, uuid, required

## Response `200`

OK

- Worksheet
  - `id` string, uuid: The unique identifier of the Worksheet.
  - `_link` string: The unique URI of the Worksheet for the specified Job.
  - `jobId` string, uuid: The unique identifier of the Job this Worksheet is for.
  - `currentState` string: The current state of the Worksheet.
  - `totalPrice` number: The total price of the Worksheet.
  - `title` string: The title of the Worksheet.
  - `sections` WorksheetSection[]
    - `id` string, uuid: The unique ID for the Worksheet section.
    - `sectionType` 'Invoice' | 'Work Not Doing' | 'Supplements' | 'Discounts' | 'Upgrades' | 'Change Order' | 'Worksheet' | 'Insurance Claim': An identifier for the type of Worksheet section.
    - `totalPrice` number: The total price of this Worksheet worksheet section.
    - `items` WorksheetItem[]
      - `id` string, uuid: The unique ID for the item.
      - `itemName` string: The name of the item.
      - `price` number: The user entered price for this item.
      - `totalPrice` number: Represents the contribution to the total of this Worksheet.
      - `parentItemId` string: The unique ID for the parent item of this item.
      - `hierarchySortOrder` number: Represents the user set sort order defined on this Worksheet.
      - `tradeId` string, uuid: The unique ID for the trade of this item.

## 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.

---

[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)