Item Ledger

The item ledger resource.

Basehttps://rest.carbon.ms/itemLedger

GET/itemLedger

List item ledgers

Retrieve a paginated list of item ledgers. 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/itemLedger

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

Response

[
  {
    "id": "abc123def456",
    "entryNumber": 0,
    "postingDate": "2026-01-01",
    "entryType": "string",
    "itemId": "xyz789",
    "quantity": 10,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/itemLedger

Retrieve a item ledger

Fetch a single item ledger by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/itemLedger

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

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "entryType": "string",
  "itemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/itemLedger

Create a item ledger

Create a new item ledger.

Body parameters

entryNumbernumberrequired

postingDatedaterequired

entryTypeitemLedgerTyperequired

documentTypeitemLedgerDocumentType

documentIdstring

externalDocumentIdstring

itemIdstringrequired

References item.id

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

quantitynumberrequired

companyIdstringrequired

References company.id

documentLineIdstring

trackedEntityIdstring

References trackedEntity.id

commentstring

trackedEntityStatustrackedEntityStatus

POSThttps://rest.carbon.ms/itemLedger

curl --request POST \
  --url https://rest.carbon.ms/itemLedger \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"entryNumber":0,"postingDate":"2026-01-01","entryType":"string","itemId":"xyz789","quantity":10,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "entryType": "string",
  "itemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/itemLedger

Update a item ledger

Update an existing item ledger, matched on `id`.

Body parameters

entryNumbernumberrequired

postingDatedaterequired

entryTypeitemLedgerTyperequired

documentTypeitemLedgerDocumentType

documentIdstring

externalDocumentIdstring

itemIdstringrequired

References item.id

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

quantitynumberrequired

companyIdstringrequired

References company.id

documentLineIdstring

trackedEntityIdstring

References trackedEntity.id

commentstring

trackedEntityStatustrackedEntityStatus

PATCHhttps://rest.carbon.ms/itemLedger

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

Response

{
  "id": "abc123def456",
  "entryNumber": 0,
  "postingDate": "2026-01-01",
  "entryType": "string",
  "itemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/itemLedger

Delete a item ledger

Delete a item ledger, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/itemLedger

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

204 No Content