Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
financials

Get Worksheet

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

get/financials/{financialsId}/worksheet

Path parameters

financialsIdstring uuid required

The Financial's unique identifier

Response

OK

idstring uuid

The unique identifier of the Worksheet.

_linkstring

The unique URI of the Worksheet for the specified Job.

jobIdstring uuid

The unique identifier of the Job this Worksheet is for.

currentStatestring

The current state of the Worksheet.

totalPricenumber

The total price of the Worksheet.

titlestring

The title of the Worksheet.

Example response

{
  "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "_link": "https://api.acculynx.com/api/v2/financials/01a7cfc1-2231-4589-9657-7f3004c06bd3/worksheet",
  "jobId": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "currentState": "Approved",
  "sections": [
    {
      "id": "43bc3071-8701-4514-92d2-0ab6934bbacc",
      "sectionType": "Worksheet",
      "items": [
        {
          "id": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
          "parentItemId": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
          "tradeId": "e8ea8f4c-14ca-4bdf-8fe6-882410316757"
        }
      ]
    }
  ]
}