Skip to main content
POST
Create 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

Body

application/json

Input schema for creating a new cost sheet (POST /costings/).

  • action: "draft" saves as draft, "submit_for_review" submits for approval
  • id: None = create new, provided = update existing

Required for both draft and submit_for_review:

  • clientId, styleId, mainCurrency

Required only for submit_for_review:

  • At least 1 bomItem AND at least 1 processingItem
action
enum<string>
required

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
id
string | null
costSheetName
string | null
clientId
string | null
styleId
string | null
skuId
string | null
mainCurrency
string
default:USD
orderQuantity
number | null
sampleStage
string | null
bomItems
BOMLineItemInput · object[]
processingItems
ProcessingLineItemInput · object[]
logisticsItems
LogisticsLineItemInput · object[]
overheadTier2Items
OverheadTier2Input · object[]
overheadTier3Items
OverheadTier3Input · object[]
profitScenarios
ProfitScenarioInput · object[]

Response

Successful Response

Response after creating 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