Carbon

Supply Actual

The supply actual resource.

Basehttps://rest.carbon.ms/supplyActual
GET/supplyActual

List supply actuals

Retrieve a paginated list of supply actuals. 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/supplyActual
curl --request GET \
  --url 'https://rest.carbon.ms/supplyActual?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "itemId": "xyz789",
    "locationId": "xyz789",
    "periodId": "xyz789",
    "sourceType": "string",
    "actualQuantity": 10,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/supplyActual

Retrieve a supply actual

Fetch a single supply actual by filtering on `itemId`.

Query parameters

itemIdstring

Match on the supply actual's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplyActual
curl --request GET \
  --url 'https://rest.carbon.ms/supplyActual?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "actualQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/supplyActual

Create a supply actual

Create a new supply actual.

Body parameters

actualQuantitynumberrequired
notesstring
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/supplyActual
curl --request POST \
  --url https://rest.carbon.ms/supplyActual \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"actualQuantity":10,"companyId":"xyz789"}'
Response
{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "actualQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/supplyActual

Update a supply actual

Update an existing supply actual, matched on `itemId`.

Body parameters

actualQuantitynumberrequired
notesstring
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/supplyActual
curl --request PATCH \
  --url 'https://rest.carbon.ms/supplyActual?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"actualQuantity":10}'
Response
{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "actualQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/supplyActual

Delete a supply actual

Delete a supply actual, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the supply actual to delete, e.g. `eq.{id}`.

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