Item Cost

The item cost resource.

Basehttps://rest.carbon.ms/itemCost

GET/itemCost

List item costs

Retrieve a paginated list of item costs. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/itemCost

curl --request GET \
  --url 'https://rest.carbon.ms/itemCost?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "itemId": "xyz789",
    "costingMethod": "string",
    "standardCost": 0,
    "costIsAdjusted": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "itemPostingGroupId": "xyz789"
  }
]

GET/itemCost

Retrieve a item cost

Fetch a single item cost by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item cost's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/itemCost

curl --request GET \
  --url 'https://rest.carbon.ms/itemCost?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "itemId": "xyz789",
  "costingMethod": "string",
  "standardCost": 0,
  "costIsAdjusted": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "itemPostingGroupId": "xyz789"
}

POST/itemCost

Create a item cost

Create a new item cost.

Body parameters

itemIdstringrequired

References item.id

itemPostingGroupIdstring

References itemPostingGroup.id

costingMethoditemCostingMethodrequired

standardCostnumberrequired

unitCostnumber

costIsAdjustedbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/itemCost

curl --request POST \
  --url https://rest.carbon.ms/itemCost \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","costingMethod":"string","standardCost":0,"costIsAdjusted":true,"companyId":"xyz789"}'

Response

{
  "itemId": "xyz789",
  "costingMethod": "string",
  "standardCost": 0,
  "costIsAdjusted": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "itemPostingGroupId": "xyz789"
}

PATCH/itemCost

Update a item cost

Update an existing item cost, matched on `itemId`.

Body parameters

itemIdstringrequired

References item.id

itemPostingGroupIdstring

References itemPostingGroup.id

costingMethoditemCostingMethodrequired

standardCostnumberrequired

unitCostnumber

costIsAdjustedbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/itemCost

curl --request PATCH \
  --url 'https://rest.carbon.ms/itemCost?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789"}'

Response

{
  "itemId": "xyz789",
  "costingMethod": "string",
  "standardCost": 0,
  "costIsAdjusted": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "itemPostingGroupId": "xyz789"
}

DELETE/itemCost

Delete a item cost

Delete a item cost, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item cost to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/itemCost

curl --request DELETE \
  --url 'https://rest.carbon.ms/itemCost?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content