Purchase Order Line

The purchase order line resource.

Basehttps://rest.carbon.ms/purchaseOrderLine

GET/purchaseOrderLine

List purchase order lines

Retrieve a paginated list of purchase order 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/purchaseOrderLine

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

Response

[
  {
    "id": "abc123def456",
    "purchaseOrderId": "xyz789",
    "purchaseOrderLineType": "string",
    "receivedComplete": true,
    "invoicedComplete": true,
    "requiresInspection": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/purchaseOrderLine

Retrieve a purchase order line

Fetch a single purchase order line by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/purchaseOrderLine

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

Response

{
  "id": "abc123def456",
  "purchaseOrderId": "xyz789",
  "purchaseOrderLineType": "string",
  "receivedComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/purchaseOrderLine

Create a purchase order line

Create a new purchase order line.

Body parameters

purchaseOrderIdstringrequired

References purchaseOrder.id

purchaseOrderLineTypepurchaseOrderLineTyperequired

itemIdstring

References item.id

assetIdstring

descriptionstring

purchaseQuantitynumber

quantityReceivednumber

quantityInvoicednumber

supplierUnitPricenumber

inventoryUnitOfMeasureCodestring

purchaseUnitOfMeasureCodestring

locationIdstring

storageUnitIdstring

References storageUnit.id

setupPricenumber

receivedCompletebooleanrequired

invoicedCompletebooleanrequired

requiresInspectionbooleanrequired

companyIdstringrequired

customFieldsobject

conversionFactornumber

tagsarray

internalNotesobject

externalNotesobject

exchangeRatenumberrequired

supplierShippingCostnumberrequired

modelUploadIdstring

References modelUpload.id

supplierTaxAmountnumberrequired

quantityToReceivenumber

quantityToInvoicenumber

supplierExtendedPricenumber

taxPercentnumber

jobIdstring

References job.id

jobOperationIdstring

References jobOperation.id

quantityShippednumber

promisedDatedate

unitPricenumber

extendedPricenumber

shippingCostnumber

taxAmountnumber

accountIdstring

References account.id

requiredDatedate

receivedDatedate

costCenterIdstring

References costCenter.id

ownerIdstring

References user.id

POSThttps://rest.carbon.ms/purchaseOrderLine

curl --request POST \
  --url https://rest.carbon.ms/purchaseOrderLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"purchaseOrderId":"xyz789","purchaseOrderLineType":"string","description":"string","receivedComplete":true,"invoicedComplete":true,"requiresInspection":true,"companyId":"xyz789","exchangeRate":0,"supplierShippingCost":0,"supplierTaxAmount":0}'

Response

{
  "id": "abc123def456",
  "purchaseOrderId": "xyz789",
  "purchaseOrderLineType": "string",
  "receivedComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/purchaseOrderLine

Update a purchase order line

Update an existing purchase order line, matched on `id`.

Body parameters

purchaseOrderIdstringrequired

References purchaseOrder.id

purchaseOrderLineTypepurchaseOrderLineTyperequired

itemIdstring

References item.id

assetIdstring

descriptionstring

purchaseQuantitynumber

quantityReceivednumber

quantityInvoicednumber

supplierUnitPricenumber

inventoryUnitOfMeasureCodestring

purchaseUnitOfMeasureCodestring

locationIdstring

storageUnitIdstring

References storageUnit.id

setupPricenumber

receivedCompletebooleanrequired

invoicedCompletebooleanrequired

requiresInspectionbooleanrequired

companyIdstringrequired

customFieldsobject

conversionFactornumber

tagsarray

internalNotesobject

externalNotesobject

exchangeRatenumberrequired

supplierShippingCostnumberrequired

modelUploadIdstring

References modelUpload.id

supplierTaxAmountnumberrequired

quantityToReceivenumber

quantityToInvoicenumber

supplierExtendedPricenumber

taxPercentnumber

jobIdstring

References job.id

jobOperationIdstring

References jobOperation.id

quantityShippednumber

promisedDatedate

unitPricenumber

extendedPricenumber

shippingCostnumber

taxAmountnumber

accountIdstring

References account.id

requiredDatedate

receivedDatedate

costCenterIdstring

References costCenter.id

ownerIdstring

References user.id

PATCHhttps://rest.carbon.ms/purchaseOrderLine

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

Response

{
  "id": "abc123def456",
  "purchaseOrderId": "xyz789",
  "purchaseOrderLineType": "string",
  "receivedComplete": true,
  "invoicedComplete": true,
  "requiresInspection": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/purchaseOrderLine

Delete a purchase order line

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/purchaseOrderLine

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

204 No Content