Skip to content

Custom Columns

The Knosc API supports user-defined custom columns on list and detail views across multiple modules. When custom columns are configured in the system, they appear automatically in the headers array of list and detail responses, and their values are included in each rows entry - no additional query parameters required.

Supported Tables

Custom columns can be configured on the following tables:

Table Scope
PurchaseOrderList Custom columns on PO header records
PurchaseOrderDetails Custom columns on PO line item records
SalesOrderList Custom columns on SO header records
SalesOrderDetails Custom columns on SO line item records
ManufacturingOrderList Custom columns on MO header records
ForecastList Custom columns on forecast header records
InventoryList Custom columns on inventory records
InventoryPlanningList Custom columns on inventory planning records

Response Behaviour

Custom columns are included automatically when they have been configured for the authenticated user's organisation. They appear alongside built-in columns in the headers array and are indistinguishable in structure:

{
  "key": "My Custom Field",
  "format": "string",
  "alias": "Custom Field"
}

And the value appears in each row alongside built-in fields:

{
  "id": 42,
  "PO List Number": "PO-2024-001",
  "My Custom Field": "custom-value-here"
}

Managing Custom Column Definitions

The API exposes endpoints to read and manage the custom column definitions themselves:

Action Endpoint
List custom column configs GET /api/custom-column
Create a custom column POST /api/custom-column
Update a custom column PUT /api/custom-column/{id}
Delete a custom column DELETE /api/custom-column/{id}

See Utilities - Custom Columns for full request/response details.

Notes

  • Custom column keys are user-defined and vary per organisation.
  • Custom column values are read-only via standard list/detail endpoints - use the dedicated custom column management endpoints above to modify definitions.
  • Custom columns are scoped per table; a column defined on PurchaseOrderList does not appear on SalesOrderList.
  • Contact your Knosc administrator to configure custom columns if you do not have the required privileges.