Receipt Line

The receipt line resource.

Basehttps://rest.carbon.ms/receiptLine

GET/receiptLine

List receipt lines

Retrieve a paginated list of receipt 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/receiptLine

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

Response

[
  {
    "id": "abc123def456",
    "receiptId": "xyz789",
    "itemId": "xyz789",
    "orderQuantity": 10,
    "outstandingQuantity": 10,
    "receivedQuantity": 10,
    "unitOfMeasure": "string",
    "unitPrice": 0
  }
]

GET/receiptLine

Retrieve a receipt line

Fetch a single receipt line by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/receiptLine

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

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "itemId": "xyz789",
  "orderQuantity": 10,
  "outstandingQuantity": 10,
  "receivedQuantity": 10,
  "unitOfMeasure": "string",
  "unitPrice": 0
}

POST/receiptLine

Create a receipt line

Create a new receipt line.

Body parameters

receiptIdstringrequired

References receipt.id

lineIdstring

itemIdstringrequired

References item.id

orderQuantitynumberrequired

outstandingQuantitynumberrequired

receivedQuantitynumberrequired

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

unitOfMeasurestringrequired

unitPricenumberrequired

companyIdstringrequired

conversionFactornumber

requiresSerialTrackingbooleanrequired

requiresBatchTrackingbooleanrequired

POSThttps://rest.carbon.ms/receiptLine

curl --request POST \
  --url https://rest.carbon.ms/receiptLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"receiptId":"xyz789","itemId":"xyz789","orderQuantity":10,"outstandingQuantity":10,"receivedQuantity":10,"unitOfMeasure":"string","unitPrice":0,"companyId":"xyz789","requiresSerialTracking":true,"requiresBatchTracking":true}'

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "itemId": "xyz789",
  "orderQuantity": 10,
  "outstandingQuantity": 10,
  "receivedQuantity": 10,
  "unitOfMeasure": "string",
  "unitPrice": 0
}

PATCH/receiptLine

Update a receipt line

Update an existing receipt line, matched on `id`.

Body parameters

receiptIdstringrequired

References receipt.id

lineIdstring

itemIdstringrequired

References item.id

orderQuantitynumberrequired

outstandingQuantitynumberrequired

receivedQuantitynumberrequired

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

unitOfMeasurestringrequired

unitPricenumberrequired

companyIdstringrequired

conversionFactornumber

requiresSerialTrackingbooleanrequired

requiresBatchTrackingbooleanrequired

PATCHhttps://rest.carbon.ms/receiptLine

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

Response

{
  "id": "abc123def456",
  "receiptId": "xyz789",
  "itemId": "xyz789",
  "orderQuantity": 10,
  "outstandingQuantity": 10,
  "receivedQuantity": 10,
  "unitOfMeasure": "string",
  "unitPrice": 0
}

DELETE/receiptLine

Delete a receipt line

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/receiptLine

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

204 No Content