v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
financials

Create Worksheet Item

Creates a new item in a worksheet using its financial ID. If the worksheet does not exist, it will be created, and the sectionId parameter should be left empty. If the worksheet already exists, you must provide the sectionId parameter, which should be a valid section ID within the worksheet.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/financials/{financialsId}/worksheet/items

Path parameters

financialsIdstring uuid required

The Financial's unique identifier

Request body

sectionIdstring uuid nullable

The unique ID of the worksheet section where the item will be created. If the worksheet does not exist, this field should be left empty.

parentItemIdstring uuid nullable

The unique ID for the parent item of this item.

itemNamestring nullable

The name of the item.

descriptionstring nullable

The description of the item.

quantityinteger nullable

The quantity for this item.

unitOfMeasurestring uuid nullable

The unique ID for the unit of measure.

costPerUnitnumber nullable

The cost/unit for this item.

costnumber nullable

The cost for this item.

pricenumber required

The price for this item.

Example request

{
  "sectionId": "acbac5e9-3728-4d23-a902-1fefb639677e",
  "parentItemId": "3ba56c6b-6bcc-4f9c-857f-48b2f5a2f83c",
  "itemName": "Accident Debris Clean Up.",
  "description": "Cleanup of all debris created when car crashed the house.",
  "quantity": 5,
  "unitOfMeasure": "65d44fe6-a627-4ef4-a3a4-a948565e0309",
  "costPerUnit": 2.35,
  "cost": 1.55,
  "price": 5.55
}

Response

Created

idstring uuid

The unique identifier of the resource to post.