Purchase Order

The purchase order resource.

Basehttps://rest.carbon.ms/purchaseOrder

GET/purchaseOrder

List purchase orders

Retrieve a paginated list of purchase orders. 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/purchaseOrder

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

Response

[
  {
    "id": "abc123def456",
    "purchaseOrderId": "xyz789",
    "revisionId": 0,
    "status": "string",
    "supplierId": "xyz789",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/purchaseOrder

Retrieve a purchase order

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/purchaseOrder

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

Response

{
  "id": "abc123def456",
  "purchaseOrderId": "xyz789",
  "revisionId": 0,
  "status": "string",
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/purchaseOrder

Create a purchase order

Create a new purchase order.

Body parameters

purchaseOrderIdstringrequired

revisionIdnumberrequired

statuspurchaseOrderStatusrequired

orderDatedate

supplierIdstringrequired

References supplier.id

supplierLocationIdstring

References supplierLocation.id

supplierContactIdstring

References supplierContact.id

supplierReferencestring

assigneestring

References user.id

companyIdstringrequired

References company.id

closedAtdate

closedBystring

References user.id

customFieldsobject

currencyCodestring

References currencyCode.code

exchangeRatenumber

exchangeRateUpdatedAttimestamp

tagsarray

internalNotesobject

externalNotesobject

supplierInteractionIdstringrequired

References supplierInteraction.id

purchaseOrderTypepurchaseOrderTyperequired

jobIdstring

References job.id

jobReadableIdstring

POSThttps://rest.carbon.ms/purchaseOrder

curl --request POST \
  --url https://rest.carbon.ms/purchaseOrder \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"purchaseOrderId":"xyz789","revisionId":0,"status":"string","supplierId":"xyz789","companyId":"xyz789","supplierInteractionId":"xyz789","purchaseOrderType":"string"}'

Response

{
  "id": "abc123def456",
  "purchaseOrderId": "xyz789",
  "revisionId": 0,
  "status": "string",
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/purchaseOrder

Update a purchase order

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

Body parameters

purchaseOrderIdstringrequired

revisionIdnumberrequired

statuspurchaseOrderStatusrequired

orderDatedate

supplierIdstringrequired

References supplier.id

supplierLocationIdstring

References supplierLocation.id

supplierContactIdstring

References supplierContact.id

supplierReferencestring

assigneestring

References user.id

companyIdstringrequired

References company.id

closedAtdate

closedBystring

References user.id

customFieldsobject

currencyCodestring

References currencyCode.code

exchangeRatenumber

exchangeRateUpdatedAttimestamp

tagsarray

internalNotesobject

externalNotesobject

supplierInteractionIdstringrequired

References supplierInteraction.id

purchaseOrderTypepurchaseOrderTyperequired

jobIdstring

References job.id

jobReadableIdstring

PATCHhttps://rest.carbon.ms/purchaseOrder

curl --request PATCH \
  --url 'https://rest.carbon.ms/purchaseOrder?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",
  "revisionId": 0,
  "status": "string",
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/purchaseOrder

Delete a purchase order

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/purchaseOrder

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

204 No Content