Skip to main content
PATCH
Update Cost Sheet

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-User-Id
string | null
X-Org-Id
string | null

Path Parameters

costing_id
string
required

The costing document ID (e.g., CS-2024-001)

Body

application/json

Input schema for updating a cost sheet (PATCH /costings/{id}). All fields are optional - only provided fields will be updated.

Use 'action' to trigger state transitions:

  • draft: Save changes without validation
  • submit_for_review: Validate and change status to Under Review (from Draft)
  • resubmit: Send a rejected cost sheet back Under Review
  • withdraw: Revert from Under Review/Approved/Rejected back to Draft
  • approve: Manager only - change status to Approved
  • reject: Manager only - change status to Rejected
action
enum<string> | null

Actions for cost sheet state transitions

Permissions:

  • draft, submit_for_review, withdraw: Any authenticated user
  • approve, reject: Manager or Admin only
Available options:
draft,
submit_for_review,
withdraw,
approve,
reject,
resubmit
reason
string | null
comments
string | null
versionNumber
integer | null
status
string | null
costSheetName
string | null
clientId
string | null
styleId
string | null
skuId
string | null
mainCurrency
string | null
orderQuantity
number | null
bomItems
BOMLineItemInput · object[] | null
processingItems
ProcessingLineItemInput · object[] | null
logisticsItems
LogisticsLineItemInput · object[] | null
overheadTier3Items
OverheadTier3Input · object[] | null
profitScenarios
ProfitScenarioInput · object[] | null

Response

Successful Response

Response after updating a cost sheet

success
boolean
required
message
string
required
cost_sheet_id
string
required
document_id
string
required
version_number
integer
required
status
string
required