DemandFlow Support Centre

LICENSE: License

Software license record tracking entitlement quantities, validity periods, costs, compliance, and installation allocations.

Default definition. This article describes the default LICENSE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches LICENSE.

Entity properties

Property	Value
Entity code	`LICENSE`
Display name	License
Plural	Licenses
Level	305

Use cases

LICENSE tracks software entitlements - the legal right to use a SOFTWARE product. It bridges the gap between what you have bought (LICENSE) and what you have deployed (SOFTWAREINSTALL). The General panel captures the license identity: internal ID, linked SOFTWARE product, license key, quantity purchased vs used vs available (with available calculated as purchased minus used).

Fields

License Information

Field	Type	Required	Notes
`name`	text	Yes	Internal identifier for this license
`software`	reference → `SOFTWARE`	Yes	Software
`licenseKey`	text		Product key or serial number
`quantity`	number	Yes	Quantity Purchased
`usedQuantity`	number		Quantity Used Read only.
`availableQuantity`	number		Calculated: Purchased - Used Read only.
`unlimited`	boolean		Unlimited License
`msSkuId`	text		Microsoft SKU identifier from Entra ID

License Details

Field	Type	Required	Notes
`licenseType`	enum	Yes	License Type Valid ids: `1` (Perpetual), `2` (Subscription), `3` (Term), `4` (Trial), `5` (NFR (Not for Resale)), `6` (Educational), `7` (OEM), `8` (Volume License).
`scope`	enum		License Scope Valid ids: `1` (Enterprise-wide), `2` (Site/Location), `3` (Department), `4` (Project), `5` (Individual).
`status`	enum	Yes	Status Valid ids: `1` (Active), `2` (Expired), `3` (Pending), `4` (Suspended), `5` (Cancelled).
`complianceStatus`	enum		Compliance Status Valid ids: `1` (Compliant), `2` (Over-deployed), `3` (Under-utilized), `4` (Review Required).

Purchase Information

Field	Type	Notes
`vendor`	reference → `VEN`	Purchased From
`purchaseOrder`	reference → `PO`	Purchase Order
`purchaseDate`	date	Purchase Date
`invoiceNumber`	text	Invoice Number
`purchaseCost`	number	Purchase Cost
`currency`	reference → `CURRENCY`	Currency

Cost Tracking

Field	Type	Notes
`costType`	enum	Cost Type Valid ids: `1` (One-time), `2` (Annual), `3` (Monthly), `4` (Quarterly), `5` (Per User/Month), `6` (Usage Based).
`annualCost`	number	Total annual cost
`unitCost`	number	Cost per unit/user
`costCenter`	text	Cost Center
`budgetCategory`	enum	Budget Category Valid ids: `1` (OpEx), `2` (CapEx).

License Period

Field	Type	Required	Notes
`startDate`	date	Yes	Start Date
`expiryDate`	date		Expiry Date
`perpetual`	boolean		Perpetual License
`autoRenew`	boolean		Auto-Renew
`renewalDate`	date		Next Renewal Date
`notificationDays`	number		Days before expiry to notify

Maintenance & Support

Field	Type	Notes
`maintenanceIncluded`	boolean	Maintenance Included
`maintenanceExpiry`	date	Maintenance Expiry
`maintenanceCost`	number	Annual Maintenance Cost
`supportLevel`	enum	Support Level Valid ids: `1` (Basic), `2` (Standard), `3` (Premium), `4` (24x7).
`supportContact`	text	Support Contact

Assignment Rules

Field	Type	Notes
`assignmentType`	enum	Assignment Type Valid ids: `1` (User Based), `2` (Device Based), `3` (Concurrent), `4` (Floating), `5` (Site License).
`assignedTo`	reference → `US`	User or department
`canReassign`	boolean	Can Reassign
`requireApproval`	boolean	Require Approval

Restrictions

Field	Type	Notes
`geographicRestriction`	text	Countries or regions
`usageRestriction`	text (multi-line)	Usage Restrictions
`transferable`	boolean	Transferable
`allowVirtualization`	boolean	Allow Virtualization

License Documentation

Field	Type	Notes
`agreementNumber`	text	Agreement Number
`contractId`	text	Contract ID
`notes`	text (multi-line)	Notes

Documents

Field	Type	Required	Notes
`file`	file

Relationships

Lookups: software points at a SOFTWARE record. vendor points at a VEN record. purchaseOrder points at a PO record. currency points at a CURRENCY record. assignedTo points at a US record.
Related lists: STFLICENSE, SOFTWAREINSTALL.

Creating a License via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "LICENSE",
  "level":    305,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example",
  "software": "",
  "quantity": 1,
  "licenseType": "1"
}

Listing Licenses records

# All licenses in your tenant
GET /v1/entities/LICENSE/SUB

DemandFlow Support Centre

LICENSE: License

LICENSE: License

Entity properties

Use cases

Fields

Relationships

Creating a License via the API

Listing Licenses records

See also

Was this article helpful?