Company Settings

The company settings resource.

Basehttps://rest.carbon.ms/companySettings

GET/companySettings

List company settingss

Retrieve a paginated list of company settingss. 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/companySettings

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

Response

[
  {
    "id": "abc123def456",
    "digitalQuoteEnabled": true,
    "digitalQuoteNotificationGroup": [],
    "digitalQuoteIncludesPurchaseOrders": true,
    "rfqReadyNotificationGroup": [],
    "inventoryJobCompletedNotificationGroup": [],
    "salesJobCompletedNotificationGroup": [],
    "materialGeneratedIds": true
  }
]

GET/companySettings

Retrieve a company settings

Fetch a single company settings by filtering on `id`.

Query parameters

idstring

Match on the company settings's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/companySettings

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

Response

{
  "id": "abc123def456",
  "digitalQuoteEnabled": true,
  "digitalQuoteNotificationGroup": [],
  "digitalQuoteIncludesPurchaseOrders": true,
  "rfqReadyNotificationGroup": [],
  "inventoryJobCompletedNotificationGroup": [],
  "salesJobCompletedNotificationGroup": [],
  "materialGeneratedIds": true
}

POST/companySettings

Create a company settings

Create a new company settings.

Body parameters

digitalQuoteEnabledbooleanrequired

digitalQuoteNotificationGrouparrayrequired

digitalQuoteIncludesPurchaseOrdersbooleanrequired

rfqReadyNotificationGrouparrayrequired

productLabelSizestring

shelfLabelSizestring

inventoryJobCompletedNotificationGrouparrayrequired

salesJobCompletedNotificationGrouparrayrequired

materialGeneratedIdsbooleanrequired

useMetricbooleanrequired

kanbanOutputkanbanOutputrequired

gaugeCalibrationExpiredNotificationGrouparrayrequired

purchasePriceUpdateTimingpurchasePriceUpdateTimingrequired

supplierQuoteNotificationGrouparrayrequired

maintenanceGenerateInAdvancebooleanrequired

maintenanceAdvanceDaysnumberrequired

maintenanceDispatchNotificationGrouparray

qualityDispatchNotificationGrouparray

operationsDispatchNotificationGrouparray

otherDispatchNotificationGrouparray

defaultSupplierCcarray

defaultCustomerCcarray

includeThumbnailsOnSalesPdfsbooleanrequired

includeThumbnailsOnPurchasingPdfsbooleanrequired

jobTravelerIncludeWorkInstructionsbooleanrequired

accountsPayableEmailstring

accountsReceivableEmailstring

accountsPayableAddressboolean

accountsReceivableAddressboolean

quoteLineCategoryMarkupsobject

qualityIssueTargetnumberrequired

consoleEnabledbooleanrequired

timeCardEnabledbooleanrequired

printingobject

updateLeadTimesOnReceiptbooleanrequired

enforceInspectionFourEyesbooleanrequired

samplingStandardsamplingStandardrequired

inventoryShelfLifeobjectrequired

accountingEnabledbooleanrequired

POSThttps://rest.carbon.ms/companySettings

curl --request POST \
  --url https://rest.carbon.ms/companySettings \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"digitalQuoteEnabled":true,"digitalQuoteNotificationGroup":[],"digitalQuoteIncludesPurchaseOrders":true,"rfqReadyNotificationGroup":[],"inventoryJobCompletedNotificationGroup":[],"salesJobCompletedNotificationGroup":[],"materialGeneratedIds":true,"useMetric":true,"kanbanOutput":"string","gaugeCalibrationExpiredNotificationGroup":[],"purchasePriceUpdateTiming":"string","supplierQuoteNotificationGroup":[],"maintenanceGenerateInAdvance":true,"maintenanceAdvanceDays":0,"includeThumbnailsOnSalesPdfs":true,"includeThumbnailsOnPurchasingPdfs":true,"jobTravelerIncludeWorkInstructions":true,"qualityIssueTarget":0,"consoleEnabled":true,"timeCardEnabled":true,"updateLeadTimesOnReceipt":true,"enforceInspectionFourEyes":true,"samplingStandard":"string","inventoryShelfLife":"string","accountingEnabled":true}'

Response

{
  "id": "abc123def456",
  "digitalQuoteEnabled": true,
  "digitalQuoteNotificationGroup": [],
  "digitalQuoteIncludesPurchaseOrders": true,
  "rfqReadyNotificationGroup": [],
  "inventoryJobCompletedNotificationGroup": [],
  "salesJobCompletedNotificationGroup": [],
  "materialGeneratedIds": true
}

PATCH/companySettings

Update a company settings

Update an existing company settings, matched on `id`.

Body parameters

digitalQuoteEnabledbooleanrequired

digitalQuoteNotificationGrouparrayrequired

digitalQuoteIncludesPurchaseOrdersbooleanrequired

rfqReadyNotificationGrouparrayrequired

productLabelSizestring

shelfLabelSizestring

inventoryJobCompletedNotificationGrouparrayrequired

salesJobCompletedNotificationGrouparrayrequired

materialGeneratedIdsbooleanrequired

useMetricbooleanrequired

kanbanOutputkanbanOutputrequired

gaugeCalibrationExpiredNotificationGrouparrayrequired

purchasePriceUpdateTimingpurchasePriceUpdateTimingrequired

supplierQuoteNotificationGrouparrayrequired

maintenanceGenerateInAdvancebooleanrequired

maintenanceAdvanceDaysnumberrequired

maintenanceDispatchNotificationGrouparray

qualityDispatchNotificationGrouparray

operationsDispatchNotificationGrouparray

otherDispatchNotificationGrouparray

defaultSupplierCcarray

defaultCustomerCcarray

includeThumbnailsOnSalesPdfsbooleanrequired

includeThumbnailsOnPurchasingPdfsbooleanrequired

jobTravelerIncludeWorkInstructionsbooleanrequired

accountsPayableEmailstring

accountsReceivableEmailstring

accountsPayableAddressboolean

accountsReceivableAddressboolean

quoteLineCategoryMarkupsobject

qualityIssueTargetnumberrequired

consoleEnabledbooleanrequired

timeCardEnabledbooleanrequired

printingobject

updateLeadTimesOnReceiptbooleanrequired

enforceInspectionFourEyesbooleanrequired

samplingStandardsamplingStandardrequired

inventoryShelfLifeobjectrequired

accountingEnabledbooleanrequired

PATCHhttps://rest.carbon.ms/companySettings

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

Response

{
  "id": "abc123def456",
  "digitalQuoteEnabled": true,
  "digitalQuoteNotificationGroup": [],
  "digitalQuoteIncludesPurchaseOrders": true,
  "rfqReadyNotificationGroup": [],
  "inventoryJobCompletedNotificationGroup": [],
  "salesJobCompletedNotificationGroup": [],
  "materialGeneratedIds": true
}

DELETE/companySettings

Delete a company settings

Delete a company settings, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the company settings to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/companySettings

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

204 No Content