Create Custom Field Definition

Create or update customfielddefinition data in Xorosoft ERP. Send the JSON payload using the field names documented in this operation and in the module export/import format used by Xorosoft ERP.

post

Authorizations

AuthorizationstringRequired

Body

Defines custom fields for a supported transaction type.

TransactionTypeNamestringRequired

Transaction type that owns the custom fields, such as Sales Order or Purchase Order.

Responses

200

Request processed successfully.

application/json

Standard Xorosoft ERP API response envelope used by most endpoints.

ResultbooleanOptional

True when the operation completed successfully.

MessagestringOptional

Human-readable success or error message.

Pageinteger · nullableOptional

Current page number when paging is enabled.

TotalPagesinteger · nullableOptional

Total page count when paging is enabled.

400

Invalid request, failed validation, or business rule error.

text/plain

401

Missing or invalid private app credentials.

403

Private app does not have permission for this request.

post/api/xerp/customfielddefinition/create

POST /api/xerp/customfielddefinition/create HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "TransactionTypeName": "Sales Order",
  "CustomFieldConfigDetailList": [
    {
      "Name": "External Channel",
      "Label": "External Channel",
      "DataType": "String",
      "ActiveFlag": true,
      "RequiredFlag": false,
      "CustomSource": false
    }
  ]
}

{
  "Result": true,
  "Message": "Request processed successfully",
  "Data": {}
}