@d19n/youfibre-odin-sdk 2.0.65 → 2.0.67

package/dist/entities-v2/OrderItem.d.ts

@@ -5,28 +5,28 @@
  *
  * @module OrderModule
  * @entity OrderItem
- * @schemaId a762f2b6-ad50-4830-bf8b-ec69da50823d
+ * @schemaId 05896109-7282-443a-be9e-4092abae5be5
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  * Generated from Odin schema definition
  */
 import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
-import { FileProperties } from './File';
-import { NoteProperties } from './Note';
-import { OrderProperties } from './Order';
-import { CustomerDeviceOntProperties } from './CustomerDeviceOnt';
-import { OfferProperties } from './Offer';
-import { ProductProperties } from './Product';
-import { BngProvisionProperties } from './BngProvision';
-import { CustomerDeviceAtaProperties } from './CustomerDeviceAta';
-import { WorkOrderProperties } from './WorkOrder';
-import { VoiceConfigurationProperties } from './VoiceConfiguration';
-import { CustomerDeviceRouterProperties } from './CustomerDeviceRouter';
 import { ReturnOrderProperties } from './ReturnOrder';
+import { WorkOrderProperties } from './WorkOrder';
+import { OrderProperties } from './Order';
 import { SplitOrderProperties } from './SplitOrder';
 import { CustomerPhonePortingProperties } from './CustomerPhonePorting';
+import { ProductProperties } from './Product';
+import { NoteProperties } from './Note';
+import { FileProperties } from './File';
+import { CustomerDeviceRouterProperties } from './CustomerDeviceRouter';
 import { OneTouchSwitchProperties } from './OneTouchSwitch';
 import { ActivityProperties } from './Activity';
+import { OfferProperties } from './Offer';
+import { VoiceConfigurationProperties } from './VoiceConfiguration';
+import { CustomerDeviceAtaProperties } from './CustomerDeviceAta';
+import { BngProvisionProperties } from './BngProvision';
+import { CustomerDeviceOntProperties } from './CustomerDeviceOnt';
 /**
  * Available types for OrderItem records
  */
@@ -40,47 +40,51 @@ export declare enum OrderItemEntityTypes {
  * PriceMatchedTo
  *
  * @remarks Available options:
- * - `BRSK` - Brsk Reward
+ * - `SKY` - Sky
+ * - `VIRGIN_MEDIA` - Virgin Media
  * - `BT`
- * - `EE`
- * - `GRAIN` - Grain
  * - `LIGHTSPEED` - LightSpeed
- * - `OTHER` - Other
+ * - `GRAIN` - Grain
+ * - `VODAFONE` - Vodafone
  * - `POP_TELECOM` - POP Telecom
- * - `SKY` - Sky
  * - `TALKTALK` - TalkTalk
+ * - `EE`
  * - `THREE` - Three
+ * - `BRSK` - Brsk Reward
+ * - `OTHER` - Other
  * - `UNKNOWN` - Unknown
- * - `VIRGIN_MEDIA` - Virgin Media
- * - `VODAFONE` - Vodafone
  */
 export declare enum OrderItemPriceMatchedTo {
-    BRSK_REWARD = "BRSK",
+    SKY = "SKY",
+    VIRGIN_MEDIA = "VIRGIN_MEDIA",
     BT = "BT",
-    EE = "EE",
-    GRAIN = "GRAIN",
     LIGHT_SPEED = "LIGHTSPEED",
-    OTHER = "OTHER",
+    GRAIN = "GRAIN",
+    VODAFONE = "VODAFONE",
     POP_TELECOM = "POP_TELECOM",
-    SKY = "SKY",
     TALK_TALK = "TALKTALK",
+    EE = "EE",
     THREE = "THREE",
-    UNKNOWN = "UNKNOWN",
-    VIRGIN_MEDIA = "VIRGIN_MEDIA",
-    VODAFONE = "VODAFONE"
+    BRSK_REWARD = "BRSK",
+    OTHER = "OTHER",
+    UNKNOWN = "UNKNOWN"
 }
 /**
- * Valid values for OrderItem.Taxable
+ * Valid values for OrderItem.BillingPeriodType
  *
- * is the item taxable (Sales - OrderItem)
+ * the billing period for the item (Sales - OrderItem)
  *
  * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
+ * - `DISCOUNT2` - Discount 2
+ * - `STANDARD` - Standard
+ * - `DISCOUNT` - Discount
+ * - `FREE` - Free
  */
-export declare enum OrderItemTaxable {
-    NO = "NO",
-    YES = "YES"
+export declare enum OrderItemBillingPeriodType {
+    DISCOUNT_2 = "DISCOUNT2",
+    STANDARD = "STANDARD",
+    DISCOUNT = "DISCOUNT",
+    FREE = "FREE"
 }
 /**
  * Valid values for OrderItem.DiscountType
@@ -96,21 +100,17 @@ export declare enum OrderItemDiscountType {
     PERCENT = "PERCENT"
 }
 /**
- * Valid values for OrderItem.BillingPeriodType
+ * Valid values for OrderItem.Taxable
  *
- * the billing period for the item (Sales - OrderItem)
+ * is the item taxable (Sales - OrderItem)
  *
  * @remarks Available options:
- * - `DISCOUNT` - Discount
- * - `DISCOUNT2` - Discount 2
- * - `FREE` - Free
- * - `STANDARD` - Standard
+ * - `YES` - Yes
+ * - `NO` - No
  */
-export declare enum OrderItemBillingPeriodType {
-    DISCOUNT = "DISCOUNT",
-    DISCOUNT_2 = "DISCOUNT2",
-    FREE = "FREE",
-    STANDARD = "STANDARD"
+export declare enum OrderItemTaxable {
+    YES = "YES",
+    NO = "NO"
 }
 /**
  * Valid values for OrderItem.AmendmentType
@@ -118,25 +118,12 @@ export declare enum OrderItemBillingPeriodType {
  * the type of the product amendment in the order item (Sales - OrderItem)
  *
  * @remarks Available options:
- * - `DOWNGRADE` - Downgrade
  * - `UPGRADE` - Upgrade
+ * - `DOWNGRADE` - Downgrade
  */
 export declare enum OrderItemAmendmentType {
-    DOWNGRADE = "DOWNGRADE",
-    UPGRADE = "UPGRADE"
-}
-/**
- * Valid values for OrderItem.TaxIncluded
- *
- * is tax included in the UnitPrice (Sales - OrderItem)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum OrderItemTaxIncluded {
-    NO = "NO",
-    YES = "YES"
+    UPGRADE = "UPGRADE",
+    DOWNGRADE = "DOWNGRADE"
 }
 /**
  * Valid values for OrderItem.Discount2Type
@@ -157,15 +144,28 @@ export declare enum OrderItemDiscount2Type {
  * status of the order item (must be closed for billing) (Sales - OrderItem)
  *
  * @remarks Available options:
- * - `CANCELLED` - Cancelled
  * - `CLOSED` - Closed
+ * - `CANCELLED` - Cancelled
  * - `OPEN` - Open
  */
 export declare enum OrderItemActivationStatus {
-    CANCELLED = "CANCELLED",
     CLOSED = "CLOSED",
+    CANCELLED = "CANCELLED",
     OPEN = "OPEN"
 }
+/**
+ * Valid values for OrderItem.TaxIncluded
+ *
+ * is tax included in the UnitPrice (Sales - OrderItem)
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum OrderItemTaxIncluded {
+    NO = "NO",
+    YES = "YES"
+}
 /**
  * Property keys for OrderItem
  * Use these constants instead of string literals for type safety
@@ -173,84 +173,84 @@ export declare enum OrderItemActivationStatus {
 export declare enum OrderItemPropertyKeys {
     /** PriceMatchedTo */
     PriceMatchedTo = "PriceMatchedTo",
-    /** the end date for the 2nd discount period (Sales - OrderItem) */
-    Discount2EndDate = "Discount2EndDate",
-    /** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem) */
-    TrialLength = "TrialLength",
-    /** the date the discount period ends (Sales - OrderItem) */
-    DiscountEndDate = "DiscountEndDate",
+    /** ExternalReference */
+    ExternalReference = "ExternalReference",
     /** Fix Brsk migration */
     ServiceId = "ServiceId",
     /** Fix Brsk Migration */
     ExternalRefBrskIsp = "ExternalRefBrskISP",
-    /** is the item taxable (Sales - OrderItem) */
-    Taxable = "Taxable",
-    /** id of the service (data/voice) on the providers network (Sales - OrderItem) */
-    NetworkServiceId = "NetworkServiceId",
-    /** quantity item (Sales - OrderItem) */
-    Quantity = "Quantity",
-    /** total line item discounts (Sales - OrderItem) */
-    TotalDiscounts = "TotalDiscounts",
-    /** the value of the 2nd discount (Sales - OrderItem) */
-    Discount2Value = "Discount2Value",
+    /** the billing period for the item (Sales - OrderItem) */
+    BillingPeriodType = "BillingPeriodType",
     /** the type of discount (Sales - OrderItem) */
     DiscountType = "DiscountType",
-    /** ExternalReference */
-    ExternalReference = "ExternalReference",
+    /** is the item taxable (Sales - OrderItem) */
+    Taxable = "Taxable",
+    /** suggested retail price cost + markup (Sales - OrderItem) */
+    UnitPrice = "UnitPrice",
     /** the value to discount (Sales - OrderItem) */
     DiscountValue = "DiscountValue",
     /** total price for the line item (Sales - OrderItem) */
     TotalPrice = "TotalPrice",
     /** name of the order item (Sales - OrderItem) */
     Name = "Name",
+    /** category of the product being sold (Sales - OrderItem) */
+    ProductCategory = "ProductCategory",
     /** the type of product being sold (Sales - OrderItem) */
     ProductType = "ProductType",
-    /** the billing period for the item (Sales - OrderItem) */
-    BillingPeriodType = "BillingPeriodType",
-    /** suggested retail price cost + markup (Sales - OrderItem) */
-    UnitPrice = "UnitPrice",
-    /** total taxes (Sales - OrderItem) */
-    TotalTaxAmount = "TotalTaxAmount",
     /** the date the trial period ends (Sales - OrderItem) */
     TrialEndDate = "TrialEndDate",
+    /** the date the discount period ends (Sales - OrderItem) */
+    DiscountEndDate = "DiscountEndDate",
+    /** the date the order was activated (Sales - OrderItem) */
+    BillingStartDate = "BillingStartDate",
+    /** total taxes (Sales - OrderItem) */
+    TotalTaxAmount = "TotalTaxAmount",
     /** value less discount and taxes, excluding free periods (Sales - OrderItem) */
     ProjectedArpu = "ProjectedARPU",
-    /** category of the product being sold (Sales - OrderItem) */
-    ProductCategory = "ProductCategory",
-    /** Discount2Length (Sales - OrderItem) */
-    Discount2Length = "Discount2Length",
-    /** the line item subtotal (Sales - OrderItem) */
-    Subtotal = "Subtotal",
-    /** DiscountLength (Sales - OrderItem) */
-    DiscountLength = "DiscountLength",
-    /** next billing date that this item will be on an invoice (Sales - OrderItem) */
-    NextBillingDate = "NextBillingDate",
-    /** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem) */
-    Vlanid = "VLANID",
     /** the type of the product amendment in the order item (Sales - OrderItem) */
     AmendmentType = "AmendmentType",
-    /** the date the order was activated (Sales - OrderItem) */
-    BillingStartDate = "BillingStartDate",
+    /** id of the service (data/voice) on the providers network (Sales - OrderItem) */
+    NetworkServiceId = "NetworkServiceId",
+    /** quantity item (Sales - OrderItem) */
+    Quantity = "Quantity",
+    /** total line item discounts (Sales - OrderItem) */
+    TotalDiscounts = "TotalDiscounts",
+    /** the line item subtotal (Sales - OrderItem) */
+    Subtotal = "Subtotal",
+    /** the end date for the 2nd discount period (Sales - OrderItem) */
+    Discount2EndDate = "Discount2EndDate",
     /** the trial unit (mapped from the Product<>Pricebook config) (Sales - OrderItem) */
     TrialUnit = "TrialUnit",
+    /** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem) */
+    TrialLength = "TrialLength",
     /** ProductPbRelationId (Sales - OrderItem) */
     ProductPbRelationId = "ProductPbRelationId",
-    /** is tax included in the UnitPrice (Sales - OrderItem) */
-    TaxIncluded = "TaxIncluded",
-    /** The item will be invoiced on this date (Sales - OrderItem) */
-    NextInvoiceDate = "NextInvoiceDate",
-    /** product customer type (Sales - OrderItem) */
-    ProductCustomerType = "ProductCustomerType",
+    /** DiscountLength (Sales - OrderItem) */
+    DiscountLength = "DiscountLength",
+    /** Discount2Length (Sales - OrderItem) */
+    Discount2Length = "Discount2Length",
+    /** the value of the 2nd discount (Sales - OrderItem) */
+    Discount2Value = "Discount2Value",
     /** the type of discount (Sales - OrderItem) */
     Discount2Type = "Discount2Type",
     /** status of the order item (must be closed for billing) (Sales - OrderItem) */
     ActivationStatus = "ActivationStatus",
-    /** id of the product (Sales - OrderItem) */
-    ProductRef = "ProductRef",
     /** description of the order item (Sales - OrderItem) */
     Description = "Description",
+    /** next billing date that this item will be on an invoice (Sales - OrderItem) */
+    NextBillingDate = "NextBillingDate",
+    /** is tax included in the UnitPrice (Sales - OrderItem) */
+    TaxIncluded = "TaxIncluded",
     /** tax rate for the item (Sales - OrderItem) */
-    TaxRate = "TaxRate"
+    TaxRate = "TaxRate",
+    /** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem) */
+    Vlanid = "VLANID",
+    /** The item will be invoiced on this date (Sales - OrderItem) */
+    NextInvoiceDate = "NextInvoiceDate",
+    /** product customer type (Sales - OrderItem) */
+    ProductCustomerType = "ProductCustomerType",
+    /** id of the product (Sales - OrderItem) */
+    ProductRef = "ProductRef"
 }
 /**
  * Properties for OrderItem records
@@ -264,26 +264,11 @@ export interface OrderItemProperties {
      * @enum {OrderItemPriceMatchedTo}
      */
     PriceMatchedTo: OrderItemPriceMatchedTo;
-    /** the end date for the 2nd discount period (Sales - OrderItem)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    Discount2EndDate: string;
-    /** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem)
-     *
-     * @type {NUMBER}
-     * @hidden This field is hidden in the UI
-     */
-    TrialLength: number;
-    /** the date the discount period ends (Sales - OrderItem)
+    /** ExternalReference
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
+     * @type {TEXT}
      */
-    DiscountEndDate: string;
+    ExternalReference: string;
     /** Fix Brsk migration
      *
      * @type {TEXT}
@@ -294,61 +279,44 @@ export interface OrderItemProperties {
      * @type {TEXT}
      */
     ExternalRefBrskIsp: string;
-    /** is the item taxable (Sales - OrderItem)
+    /** the billing period for the item (Sales - OrderItem)
      *
      * @type {ENUM}
-     * @default YES
-     * @enum {OrderItemTaxable}
+     * @enum {OrderItemBillingPeriodType}
      * @hidden This field is hidden in the UI
      */
-    Taxable: OrderItemTaxable;
-    /** id of the service (data/voice) on the providers network (Sales - OrderItem)
+    BillingPeriodType: OrderItemBillingPeriodType;
+    /** the type of discount (Sales - OrderItem)
      *
-     * @type {TEXT}
+     * @type {ENUM}
+     * @default
+     * @enum {OrderItemDiscountType}
      * @hidden This field is hidden in the UI
      */
-    NetworkServiceId: string;
-    /** quantity item (Sales - OrderItem)
+    DiscountType: OrderItemDiscountType;
+    /** is the item taxable (Sales - OrderItem)
      *
-     * @type {NUMBER}
-     * @default 1
+     * @type {ENUM}
+     * @default YES
+     * @enum {OrderItemTaxable}
      * @hidden This field is hidden in the UI
      */
-    Quantity: number;
-    /** total line item discounts (Sales - OrderItem)
+    Taxable: OrderItemTaxable;
+    /** suggested retail price cost + markup (Sales - OrderItem)
      *
      * @type {CURRENCY}
      * @default 0
      * @hidden This field is hidden in the UI
      */
-    TotalDiscounts: string;
-    /** the value of the 2nd discount (Sales - OrderItem)
+    UnitPrice: string;
+    /** the value to discount (Sales - OrderItem)
      *
      * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    Discount2Value: string;
-    /** the type of discount (Sales - OrderItem)
-     *
-     * @type {ENUM}
-     * @default
-     * @enum {OrderItemDiscountType}
-     * @hidden This field is hidden in the UI
-     */
-    DiscountType: OrderItemDiscountType;
-    /** ExternalReference
-     *
-     * @type {TEXT}
-     */
-    ExternalReference: string;
-    /** the value to discount (Sales - OrderItem)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    DiscountValue: string;
-    /** total price for the line item (Sales - OrderItem)
+    DiscountValue: string;
+    /** total price for the line item (Sales - OrderItem)
      *
      * @type {CURRENCY}
      * @default 0
@@ -361,131 +329,129 @@ export interface OrderItemProperties {
      * @hidden This field is hidden in the UI
      */
     Name: string;
-    /** the type of product being sold (Sales - OrderItem)
+    /** category of the product being sold (Sales - OrderItem)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    ProductType: string;
-    /** the billing period for the item (Sales - OrderItem)
+    ProductCategory: string;
+    /** the type of product being sold (Sales - OrderItem)
      *
-     * @type {ENUM}
-     * @enum {OrderItemBillingPeriodType}
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    BillingPeriodType: OrderItemBillingPeriodType;
-    /** suggested retail price cost + markup (Sales - OrderItem)
+    ProductType: string;
+    /** the date the trial period ends (Sales - OrderItem)
      *
-     * @type {CURRENCY}
-     * @default 0
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    UnitPrice: string;
-    /** total taxes (Sales - OrderItem)
+    TrialEndDate: string;
+    /** the date the discount period ends (Sales - OrderItem)
      *
-     * @type {CURRENCY}
-     * @default 0
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    TotalTaxAmount: string;
-    /** the date the trial period ends (Sales - OrderItem)
+    DiscountEndDate: string;
+    /** the date the order was activated (Sales - OrderItem)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    TrialEndDate: string;
-    /** value less discount and taxes, excluding free periods (Sales - OrderItem)
+    BillingStartDate: string;
+    /** total taxes (Sales - OrderItem)
      *
      * @type {CURRENCY}
      * @default 0
      * @hidden This field is hidden in the UI
      */
-    ProjectedArpu: string;
-    /** category of the product being sold (Sales - OrderItem)
+    TotalTaxAmount: string;
+    /** value less discount and taxes, excluding free periods (Sales - OrderItem)
      *
-     * @type {TEXT}
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    ProductCategory: string;
-    /** Discount2Length (Sales - OrderItem)
+    ProjectedArpu: string;
+    /** the type of the product amendment in the order item (Sales - OrderItem)
      *
-     * @type {NUMBER}
+     * @type {ENUM}
+     * @enum {OrderItemAmendmentType}
      * @hidden This field is hidden in the UI
      */
-    Discount2Length: number;
-    /** the line item subtotal (Sales - OrderItem)
+    AmendmentType: OrderItemAmendmentType;
+    /** id of the service (data/voice) on the providers network (Sales - OrderItem)
      *
-     * @type {CURRENCY}
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    Subtotal: string;
-    /** DiscountLength (Sales - OrderItem)
+    NetworkServiceId: string;
+    /** quantity item (Sales - OrderItem)
      *
      * @type {NUMBER}
+     * @default 1
      * @hidden This field is hidden in the UI
      */
-    DiscountLength: number;
-    /** next billing date that this item will be on an invoice (Sales - OrderItem)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    NextBillingDate: string;
-    /** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem)
+    Quantity: number;
+    /** total line item discounts (Sales - OrderItem)
      *
-     * @type {TEXT}
-     * @default
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    Vlanid: string;
-    /** the type of the product amendment in the order item (Sales - OrderItem)
+    TotalDiscounts: string;
+    /** the line item subtotal (Sales - OrderItem)
      *
-     * @type {ENUM}
-     * @enum {OrderItemAmendmentType}
+     * @type {CURRENCY}
      * @hidden This field is hidden in the UI
      */
-    AmendmentType: OrderItemAmendmentType;
-    /** the date the order was activated (Sales - OrderItem)
+    Subtotal: string;
+    /** the end date for the 2nd discount period (Sales - OrderItem)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    BillingStartDate: string;
+    Discount2EndDate: string;
     /** the trial unit (mapped from the Product<>Pricebook config) (Sales - OrderItem)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
     TrialUnit: string;
+    /** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem)
+     *
+     * @type {NUMBER}
+     * @hidden This field is hidden in the UI
+     */
+    TrialLength: number;
     /** ProductPbRelationId (Sales - OrderItem)
      *
      * @type {UUID}
      * @hidden This field is hidden in the UI
      */
     ProductPbRelationId: string;
-    /** is tax included in the UnitPrice (Sales - OrderItem)
+    /** DiscountLength (Sales - OrderItem)
      *
-     * @type {ENUM}
-     * @default YES
-     * @enum {OrderItemTaxIncluded}
+     * @type {NUMBER}
      * @hidden This field is hidden in the UI
      */
-    TaxIncluded: OrderItemTaxIncluded;
-    /** The item will be invoiced on this date (Sales - OrderItem)
+    DiscountLength: number;
+    /** Discount2Length (Sales - OrderItem)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {NUMBER}
      * @hidden This field is hidden in the UI
      */
-    NextInvoiceDate: string;
-    /** product customer type (Sales - OrderItem)
+    Discount2Length: number;
+    /** the value of the 2nd discount (Sales - OrderItem)
      *
-     * @type {TEXT}
+     * @type {CURRENCY}
+     * @hidden This field is hidden in the UI
      */
-    ProductCustomerType: string;
+    Discount2Value: string;
     /** the type of discount (Sales - OrderItem)
      *
      * @type {ENUM}
@@ -501,18 +467,27 @@ export interface OrderItemProperties {
      * @hidden This field is hidden in the UI
      */
     ActivationStatus: OrderItemActivationStatus;
-    /** id of the product (Sales - OrderItem)
-     *
-     * @type {UUID}
-     * @hidden This field is hidden in the UI
-     */
-    ProductRef: string;
     /** description of the order item (Sales - OrderItem)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
     Description: string;
+    /** next billing date that this item will be on an invoice (Sales - OrderItem)
+     *
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
+     */
+    NextBillingDate: string;
+    /** is tax included in the UnitPrice (Sales - OrderItem)
+     *
+     * @type {ENUM}
+     * @default YES
+     * @enum {OrderItemTaxIncluded}
+     * @hidden This field is hidden in the UI
+     */
+    TaxIncluded: OrderItemTaxIncluded;
     /** tax rate for the item (Sales - OrderItem)
      *
      * @type {NUMBER}
@@ -520,6 +495,31 @@ export interface OrderItemProperties {
      * @hidden This field is hidden in the UI
      */
     TaxRate: number;
+    /** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem)
+     *
+     * @type {TEXT}
+     * @default
+     * @hidden This field is hidden in the UI
+     */
+    Vlanid: string;
+    /** The item will be invoiced on this date (Sales - OrderItem)
+     *
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
+     */
+    NextInvoiceDate: string;
+    /** product customer type (Sales - OrderItem)
+     *
+     * @type {TEXT}
+     */
+    ProductCustomerType: string;
+    /** id of the product (Sales - OrderItem)
+     *
+     * @type {UUID}
+     * @hidden This field is hidden in the UI
+     */
+    ProductRef: string;
 }
 /**
  * OrderItem entity from OrderModule
@@ -528,49 +528,49 @@ export interface OrderItemProperties {
  *
  * @module OrderModule
  * @entity OrderItem
- * @schemaId a762f2b6-ad50-4830-bf8b-ec69da50823d
+ * @schemaId 05896109-7282-443a-be9e-4092abae5be5
  * @recordPrefix OR-IT
  * @capabilities searchable, updateable, undeletable, triggerable
  */
 export declare class OrderItem extends OdinRecord<OrderItemProperties> {
     entity: 'OrderModule:OrderItem';
     type: OrderItemEntityTypes;
-    schemaId: 'a762f2b6-ad50-4830-bf8b-ec69da50823d';
+    schemaId: '05896109-7282-443a-be9e-4092abae5be5';
     properties: OrderItemProperties;
-    /** Linked File records (OrderItem__File) */
-    File: OdinLink<LinkedOdinRecord<FileProperties>>;
-    /** Linked Note records (OrderItem__Note) */
-    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
-    /** Linked Order records (Order_OrderItem) */
-    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
-    /** Linked CustomerDeviceOnt records (OrderItem__CustomerDeviceOnt) */
-    CustomerDeviceOnt: OdinLink<LinkedOdinRecord<CustomerDeviceOntProperties>>;
-    /** Linked Offer records (OrderItem__Offer) */
-    Offer: OdinLink<LinkedOdinRecord<OfferProperties>>;
-    /** Linked Product records (OrderItem__Product) */
-    Product: OdinLink<LinkedOdinRecord<ProductProperties>>;
-    /** Linked BngProvision records (OrderItem__BngProvision) */
-    BngProvision: OdinLink<LinkedOdinRecord<BngProvisionProperties>>;
-    /** Linked CustomerDeviceAta records (OrderItem__CustomerDeviceAta) */
-    CustomerDeviceAta: OdinLink<LinkedOdinRecord<CustomerDeviceAtaProperties>>;
-    /** Linked WorkOrder records (WorkOrder__OrderItem) */
-    WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
-    /** Linked VoiceConfiguration records (OrderItem__VoiceConfiguration) */
-    VoiceConfiguration: OdinLink<LinkedOdinRecord<VoiceConfigurationProperties>>;
-    /** Linked CustomerDeviceRouter records (OrderItem__CustomerDeviceRouter) */
-    CustomerDeviceRouter: OdinLink<LinkedOdinRecord<CustomerDeviceRouterProperties>>;
     /** Linked ReturnOrder records (ReturnOrder__OrderItem) */
     ReturnOrder: OdinLink<LinkedOdinRecord<ReturnOrderProperties>>;
+    /** Linked WorkOrder records (WorkOrder__OrderItem) */
+    WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
+    /** Linked Order records (Order_OrderItem) */
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
     /** Linked SplitOrder records (SplitOrder__OrderItem) */
     SplitOrder: OdinLink<LinkedOdinRecord<SplitOrderProperties>>;
     /** Linked CustomerPhonePorting records (OrderItem__CustomerPhonePorting) */
     CustomerPhonePorting: OdinLink<LinkedOdinRecord<CustomerPhonePortingProperties>>;
+    /** Linked Product records (OrderItem__Product) */
+    Product: OdinLink<LinkedOdinRecord<ProductProperties>>;
+    /** Linked Note records (OrderItem__Note) */
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
+    /** Linked File records (OrderItem__File) */
+    File: OdinLink<LinkedOdinRecord<FileProperties>>;
+    /** Linked CustomerDeviceRouter records (OrderItem__CustomerDeviceRouter) */
+    CustomerDeviceRouter: OdinLink<LinkedOdinRecord<CustomerDeviceRouterProperties>>;
     /** Linked OneTouchSwitch records (OneTouchSwitch__OrderItem) */
     OneTouchSwitch: OdinLink<LinkedOdinRecord<OneTouchSwitchProperties>>;
     /** Linked Activity records (OrderItem__Activity) */
     Activity: OdinLink<LinkedOdinRecord<ActivityProperties>>;
     /** Linked OrderItem records (OrderItem__OrderItem) */
     OrderItem: OdinLink<LinkedOdinRecord<OrderItemProperties>>;
+    /** Linked Offer records (OrderItem__Offer) */
+    Offer: OdinLink<LinkedOdinRecord<OfferProperties>>;
+    /** Linked VoiceConfiguration records (OrderItem__VoiceConfiguration) */
+    VoiceConfiguration: OdinLink<LinkedOdinRecord<VoiceConfigurationProperties>>;
+    /** Linked CustomerDeviceAta records (OrderItem__CustomerDeviceAta) */
+    CustomerDeviceAta: OdinLink<LinkedOdinRecord<CustomerDeviceAtaProperties>>;
+    /** Linked BngProvision records (OrderItem__BngProvision) */
+    BngProvision: OdinLink<LinkedOdinRecord<BngProvisionProperties>>;
+    /** Linked CustomerDeviceOnt records (OrderItem__CustomerDeviceOnt) */
+    CustomerDeviceOnt: OdinLink<LinkedOdinRecord<CustomerDeviceOntProperties>>;
 }
 /**
  * RabbitMQ routing keys for OrderItem events
@@ -588,46 +588,26 @@ export declare const ROUTING_KEY_ORDER_ITEM_DEFAULT_CREATED = "OrderModule.Order
 export declare const ROUTING_KEY_ORDER_ITEM_DEFAULT_UPDATED = "OrderModule.OrderItem.DEFAULT.SubDbRecordUpdated";
 /** Default record type deleted */
 export declare const ROUTING_KEY_ORDER_ITEM_DEFAULT_DELETED = "OrderModule.OrderItem.DEFAULT.SubDbRecordDeleted";
-/** Event: OrderItem__File link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_FILE_CREATED = "OrderModule.OrderItem.File.SubDbRecordAssociationCreated";
-/** Event: OrderItem__File link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_FILE_DELETED = "OrderModule.OrderItem.File.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__Note link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_NOTE_CREATED = "OrderModule.OrderItem.Note.SubDbRecordAssociationCreated";
-/** Event: OrderItem__Note link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_NOTE_DELETED = "OrderModule.OrderItem.Note.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__CustomerDeviceOnt link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_CREATED = "OrderModule.OrderItem.CustomerDeviceOnt.SubDbRecordAssociationCreated";
-/** Event: OrderItem__CustomerDeviceOnt link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_DELETED = "OrderModule.OrderItem.CustomerDeviceOnt.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__Offer link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_OFFER_CREATED = "OrderModule.OrderItem.Offer.SubDbRecordAssociationCreated";
-/** Event: OrderItem__Offer link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_OFFER_DELETED = "OrderModule.OrderItem.Offer.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__CustomerPhonePorting link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_CREATED = "OrderModule.OrderItem.CustomerPhonePorting.SubDbRecordAssociationCreated";
+/** Event: OrderItem__CustomerPhonePorting link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_DELETED = "OrderModule.OrderItem.CustomerPhonePorting.SubDbRecordAssociationDeleted";
 /** Event: OrderItem__Product link created */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_CREATED = "OrderModule.OrderItem.Product.SubDbRecordAssociationCreated";
 /** Event: OrderItem__Product link deleted */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_DELETED = "OrderModule.OrderItem.Product.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__BngProvision link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_CREATED = "OrderModule.OrderItem.BngProvision.SubDbRecordAssociationCreated";
-/** Event: OrderItem__BngProvision link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_DELETED = "OrderModule.OrderItem.BngProvision.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__CustomerDeviceAta link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_CREATED = "OrderModule.OrderItem.CustomerDeviceAta.SubDbRecordAssociationCreated";
-/** Event: OrderItem__CustomerDeviceAta link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_DELETED = "OrderModule.OrderItem.CustomerDeviceAta.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__VoiceConfiguration link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_CREATED = "OrderModule.OrderItem.VoiceConfiguration.SubDbRecordAssociationCreated";
-/** Event: OrderItem__VoiceConfiguration link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_DELETED = "OrderModule.OrderItem.VoiceConfiguration.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__Note link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_NOTE_CREATED = "OrderModule.OrderItem.Note.SubDbRecordAssociationCreated";
+/** Event: OrderItem__Note link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_NOTE_DELETED = "OrderModule.OrderItem.Note.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__File link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_FILE_CREATED = "OrderModule.OrderItem.File.SubDbRecordAssociationCreated";
+/** Event: OrderItem__File link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_FILE_DELETED = "OrderModule.OrderItem.File.SubDbRecordAssociationDeleted";
 /** Event: OrderItem__CustomerDeviceRouter link created */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_CREATED = "OrderModule.OrderItem.CustomerDeviceRouter.SubDbRecordAssociationCreated";
 /** Event: OrderItem__CustomerDeviceRouter link deleted */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_DELETED = "OrderModule.OrderItem.CustomerDeviceRouter.SubDbRecordAssociationDeleted";
-/** Event: OrderItem__CustomerPhonePorting link created */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_CREATED = "OrderModule.OrderItem.CustomerPhonePorting.SubDbRecordAssociationCreated";
-/** Event: OrderItem__CustomerPhonePorting link deleted */
-export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_DELETED = "OrderModule.OrderItem.CustomerPhonePorting.SubDbRecordAssociationDeleted";
 /** Event: OrderItem__Activity link created */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_CREATED = "OrderModule.OrderItem.Activity.SubDbRecordAssociationCreated";
 /** Event: OrderItem__Activity link deleted */
@@ -636,3 +616,23 @@ export declare const ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_DELETED = "OrderModule
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_CREATED = "OrderModule.OrderItem.OrderItem.SubDbRecordAssociationCreated";
 /** Event: OrderItem__OrderItem link deleted */
 export declare const ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_DELETED = "OrderModule.OrderItem.OrderItem.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__Offer link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_OFFER_CREATED = "OrderModule.OrderItem.Offer.SubDbRecordAssociationCreated";
+/** Event: OrderItem__Offer link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_OFFER_DELETED = "OrderModule.OrderItem.Offer.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__VoiceConfiguration link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_CREATED = "OrderModule.OrderItem.VoiceConfiguration.SubDbRecordAssociationCreated";
+/** Event: OrderItem__VoiceConfiguration link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_DELETED = "OrderModule.OrderItem.VoiceConfiguration.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__CustomerDeviceAta link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_CREATED = "OrderModule.OrderItem.CustomerDeviceAta.SubDbRecordAssociationCreated";
+/** Event: OrderItem__CustomerDeviceAta link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_DELETED = "OrderModule.OrderItem.CustomerDeviceAta.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__BngProvision link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_CREATED = "OrderModule.OrderItem.BngProvision.SubDbRecordAssociationCreated";
+/** Event: OrderItem__BngProvision link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_DELETED = "OrderModule.OrderItem.BngProvision.SubDbRecordAssociationDeleted";
+/** Event: OrderItem__CustomerDeviceOnt link created */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_CREATED = "OrderModule.OrderItem.CustomerDeviceOnt.SubDbRecordAssociationCreated";
+/** Event: OrderItem__CustomerDeviceOnt link deleted */
+export declare const ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_DELETED = "OrderModule.OrderItem.CustomerDeviceOnt.SubDbRecordAssociationDeleted";