Carbon

Inventory Count Line

The inventory count line resource.

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

List inventory count lines

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

Retrieve a inventory count line

Fetch a single inventory count line by filtering on `id`.

Query parameters

idstring

Match on the inventory count line's `id`, e.g. `eq.{id}`.

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

Create a inventory count line

Create a new inventory count line.

Body parameters

inventoryCountIdstringrequired
itemIdstringrequired

References item.id

locationIdstring
storageUnitIdstring
trackedEntityIdstring
readableIdstring
systemQuantitynumberrequired
countedQuantitynumber
variancenumber
countedBystring

References user.id

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

Update a inventory count line

Update an existing inventory count line, matched on `id`.

Body parameters

inventoryCountIdstringrequired
itemIdstringrequired

References item.id

locationIdstring
storageUnitIdstring
trackedEntityIdstring
readableIdstring
systemQuantitynumberrequired
countedQuantitynumber
variancenumber
countedBystring

References user.id

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

Delete a inventory count line

Delete a inventory count line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the inventory count line to delete, e.g. `eq.{id}`.

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