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

# Get Worksheet

`GET /financials/{financialsId}/worksheet`

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` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `404` — Not Found - The requested resource does not exist. Common causes: - Invalid subscription ID - Subscription has been deleted - URL path contains typos or incorrect values

---

[API](https://skmtc.net/acculynx/apis/acculynx-api-v2.md) · [All operations](https://skmtc.net/acculynx/apis/acculynx-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acculynx/acculynx-api-v2/revisions/3a9e3886e400/schema)