Purchasing Rfq Line

The purchasing rfq line resource.

Basehttps://rest.carbon.ms/purchasingRfqLine

GET/purchasingRfqLine

List purchasing rfq lines

Retrieve a paginated list of purchasing rfq 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/purchasingRfqLine

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

Response

[
  {
    "id": "abc123def456",
    "purchasingRfqId": "xyz789",
    "itemId": "xyz789",
    "purchaseUnitOfMeasureCode": "string",
    "inventoryUnitOfMeasureCode": "string",
    "order": 0,
    "companyId": "xyz789",
    "createdBy": "string"
  }
]

GET/purchasingRfqLine

Retrieve a purchasing rfq line

Fetch a single purchasing rfq line by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/purchasingRfqLine

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

Response

{
  "id": "abc123def456",
  "purchasingRfqId": "xyz789",
  "itemId": "xyz789",
  "purchaseUnitOfMeasureCode": "string",
  "inventoryUnitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

POST/purchasingRfqLine

Create a purchasing rfq line

Create a new purchasing rfq line.

Body parameters

purchasingRfqIdstringrequired

References purchasingRfq.id

itemIdstringrequired

References item.id

descriptionstring

quantityarray

purchaseUnitOfMeasureCodestringrequired

inventoryUnitOfMeasureCodestringrequired

conversionFactornumber

ordernumberrequired

internalNotesobject

externalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/purchasingRfqLine

curl --request POST \
  --url https://rest.carbon.ms/purchasingRfqLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"purchasingRfqId":"xyz789","itemId":"xyz789","description":"string","purchaseUnitOfMeasureCode":"string","inventoryUnitOfMeasureCode":"string","order":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "purchasingRfqId": "xyz789",
  "itemId": "xyz789",
  "purchaseUnitOfMeasureCode": "string",
  "inventoryUnitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

PATCH/purchasingRfqLine

Update a purchasing rfq line

Update an existing purchasing rfq line, matched on `id`.

Body parameters

purchasingRfqIdstringrequired

References purchasingRfq.id

itemIdstringrequired

References item.id

descriptionstring

quantityarray

purchaseUnitOfMeasureCodestringrequired

inventoryUnitOfMeasureCodestringrequired

conversionFactornumber

ordernumberrequired

internalNotesobject

externalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/purchasingRfqLine

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

Response

{
  "id": "abc123def456",
  "purchasingRfqId": "xyz789",
  "itemId": "xyz789",
  "purchaseUnitOfMeasureCode": "string",
  "inventoryUnitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

DELETE/purchasingRfqLine

Delete a purchasing rfq line

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/purchasingRfqLine

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

204 No Content