Discriminator Values

• ProductOrder
• ProductOrderOSM

{
    "required":[
        "productOrderItem"
    ],
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOrder":"#/components/schemas/ProductOrder",
            "ProductOrderOSM":"#/components/schemas/ProductOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID created on repository side (OM system)."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the order."
        },
        "cancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled. This is used when order is cancelled.",
            "format":"date-time"
        },
        "cancellationReason":{
            "type":"string",
            "description":"Reason why the order is cancelled. This is used when order is cancelled. "
        },
        "category":{
            "type":"string",
            "description":"Used to categorize the order from a business perspective that can be useful for the OM system (For example, \"enterprise\", \"residential\", ...)"
        },
        "completionDate":{
            "type":"string",
            "description":"Date when the order was completed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"Description of the product order."
        },
        "expectedCompletionDate":{
            "type":"string",
            "description":"Expected delivery date amended by the provider.",
            "format":"date-time"
        },
        "externalId":{
            "type":"string",
            "description":"ID provided and understandable only by the consumer."
        },
        "notificationContact":{
            "type":"string",
            "description":"Contact attached to the order to send back information regarding this order."
        },
        "orderDate":{
            "type":"string",
            "description":"Date when the order was created.",
            "format":"date-time"
        },
        "priority":{
            "type":"string",
            "description":"A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)"
        },
        "requestedCompletionDate":{
            "type":"string",
            "description":"Requested delivery date from the requestor perspective.",
            "format":"date-time"
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date.",
            "format":"date-time"
        },
        "agreement":{
            "type":"array",
            "description":"A reference to an agreement defined in the context of the product order.",
            "items":{
                "$ref":"#/components/schemas/AgreementRef"
            }
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "channel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedChannel"
            }
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Note"
            }
        },
        "orderTotalPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderPrice"
            }
        },
        "payment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PaymentRef"
            }
        },
        "productOfferingQualification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingQualificationRef"
            }
        },
        "productOrderItem":{
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOrderItem"
            }
        },
        "quote":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QuoteRef"
            }
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "state":{
            "$ref":"#/components/schemas/ProductOrderStateType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"A Product Order is a type of order that can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• agreement: array agreement
  A reference to an agreement defined in the context of the product order.
• billingAccount: object BillingAccountRef
  BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
• cancellationDate: string (date-time)
  Date when the order is cancelled. This is used when order is cancelled.
• cancellationReason: string
  Reason why the order is cancelled. This is used when order is cancelled.
• category: string
  Used to categorize the order from a business perspective that can be useful for the OM system (For example, "enterprise", "residential", ...)
• channel: array channel
• completionDate: string (date-time)
  Date when the order was completed.
• description: string
  Description of the product order.
• expectedCompletionDate: string (date-time)
  Expected delivery date amended by the provider.
• externalId: string
  ID provided and understandable only by the consumer.
• href: string
  Hyperlink to access the order.
• id: string
  ID created on repository side (OM system).
• note: array note
• notificationContact: string
  Contact attached to the order to send back information regarding this order.
• orderDate: string (date-time)
  Date when the order was created.
• orderTotalPrice: array orderTotalPrice
• payment: array payment
• priority: string
  A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)
• productOfferingQualification: array productOfferingQualification
• productOrderItem(required): array productOrderItem
  Minimum Number of Items: 1
• quote: array quote
• relatedParty: array relatedParty
• requestedCompletionDate: string (date-time)
  Requested delivery date from the requestor perspective.
• requestedStartDate: string (date-time)
  Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date.
• state: string
  Allowed Values: [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation", "inProgress.fallout", "amending.fallout", "amending", "pendingCancellation.fallout", "inProgress.suspended", "inProgress.fallout.suspended", "amending.suspended", "amending.fallout.suspended", "pendingCancellation.suspended", "pendingCancellation.fallout.suspended" ]

  Possible values for the state of the order.

{
    "required":[
        "productOrderItem"
    ],
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOrder":"#/components/schemas/ProductOrder",
            "ProductOrderOSM":"#/components/schemas/ProductOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID created on repository side (OM system)."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the order."
        },
        "cancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled. This is used when order is cancelled.",
            "format":"date-time"
        },
        "cancellationReason":{
            "type":"string",
            "description":"Reason why the order is cancelled. This is used when order is cancelled. "
        },
        "category":{
            "type":"string",
            "description":"Used to categorize the order from a business perspective that can be useful for the OM system (For example, \"enterprise\", \"residential\", ...)"
        },
        "completionDate":{
            "type":"string",
            "description":"Date when the order was completed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"Description of the product order."
        },
        "expectedCompletionDate":{
            "type":"string",
            "description":"Expected delivery date amended by the provider.",
            "format":"date-time"
        },
        "externalId":{
            "type":"string",
            "description":"ID provided and understandable only by the consumer."
        },
        "notificationContact":{
            "type":"string",
            "description":"Contact attached to the order to send back information regarding this order."
        },
        "orderDate":{
            "type":"string",
            "description":"Date when the order was created.",
            "format":"date-time"
        },
        "priority":{
            "type":"string",
            "description":"A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)"
        },
        "requestedCompletionDate":{
            "type":"string",
            "description":"Requested delivery date from the requestor perspective.",
            "format":"date-time"
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date.",
            "format":"date-time"
        },
        "agreement":{
            "type":"array",
            "description":"A reference to an agreement defined in the context of the product order.",
            "items":{
                "$ref":"#/components/schemas/AgreementRef"
            }
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "channel":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedChannel"
            }
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Note"
            }
        },
        "orderTotalPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderPrice"
            }
        },
        "payment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PaymentRef"
            }
        },
        "productOfferingQualification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingQualificationRef"
            }
        },
        "productOrderItem":{
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOrderItem"
            }
        },
        "quote":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QuoteRef"
            }
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "state":{
            "$ref":"#/components/schemas/ProductOrderStateType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"A Product Order is a type of order that can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa."
}

• Array of: object AgreementRef
  Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

{
    "type":"array",
    "description":"A reference to an agreement defined in the context of the product order.",
    "items":{
        "$ref":"#/components/schemas/AgreementRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the billing account.
• id(required): string
  Unique identifier of the billing account.
• name: string
  Name of the billing account.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the billing account."
        },
        "href":{
            "type":"string",
            "description":"Reference of the billing account."
        },
        "name":{
            "type":"string",
            "description":"Name of the billing account."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"BillingAccount reference. A BillingAccount is a detailed description of a bill structure."
}

• Array of: object RelatedChannel
  Related channel to another entity. May be online web, mobile app, social ,etc.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedChannel"
    }
}

• Array of: object Note
  Extra information about a given entity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Note"
    }
}

• Array of: object OrderPrice
  An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrderPrice"
    }
}

• Array of: object PaymentRef
  If an immediate payment has been done at the product order submission, the payment information is captured and stored (as a reference) in the order.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentRef"
    }
}

• Array of: object ProductOfferingQualificationRef
  It is a productOfferingQualification that has been executed previously.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingQualificationRef"
    }
}

• Array of: object ProductOrderItem
  An identified part of the order. A product order is decomposed into one or more order items.

{
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOrderItem"
    }
}

• Array of: object QuoteRef
  It is a Quote that has been executed previously.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QuoteRef"
    }
}

• Array of: object RelatedParty
  Related Entity reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the agreement

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the agreement"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the channel.
• role: string
  Role playing by the channel.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        },
        "role":{
            "type":"string",
            "description":"Role playing by the channel."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Related channel to another entity. May be online web, mobile app, social ,etc."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• author: string
  Author of the note.
• date: string (date-time)
  Date of the note.
• id: string
  Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation).
• text(required): string
  Text of the note.

{
    "required":[
        "text"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)."
        },
        "author":{
            "type":"string",
            "description":"Author of the note."
        },
        "date":{
            "type":"string",
            "description":"Date of the note.",
            "format":"date-time"
        },
        "text":{
            "type":"string",
            "description":"Text of the note."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Extra information about a given entity."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• billingAccount: object BillingAccountRef
  BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
• description: string
  A narrative that explains in detail the semantics of this order item price.
• name: string
  A short descriptive name such as "Subscription price".
• price: object Price
  Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
• priceAlteration: array priceAlteration
  A strucuture used to describe a price alteration.
• priceType: string
  A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.
• productOfferingPrice: object ProductOfferingPriceRef
  ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
• recurringChargePeriod: string
  Could be month, week...
• unitOfMeasure: string
  Could be minutes, GB...

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail the semantics of this order item price."
        },
        "name":{
            "type":"string",
            "description":"A short descriptive name such as \"Subscription price\"."
        },
        "priceType":{
            "type":"string",
            "description":"A category that describes the price, such as recurring, discount, allowance, penalty, and so forth."
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Could be month, week..."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB..."
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        },
        "priceAlteration":{
            "type":"array",
            "description":"A strucuture used to describe a price alteration.",
            "items":{
                "$ref":"#/components/schemas/PriceAlteration"
            }
        },
        "productOfferingPrice":{
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An amount, usually of money, that represents the actual price paid by the Customer for this item or this order."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• dutyFreeAmount: object Money
  A base / value business entity used to represent money.
• percentage: number (float)
  Percentage to apply for ProdOfferPriceAlteration.
• taxIncludedAmount: object Money
  A base / value business entity used to represent money.
• taxRate: number (float)
  Tax rate

{
    "type":"object",
    "properties":{
        "percentage":{
            "type":"number",
            "description":"Percentage to apply for ProdOfferPriceAlteration.",
            "format":"float"
        },
        "taxRate":{
            "type":"number",
            "description":"Tax rate",
            "format":"float"
        },
        "dutyFreeAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "taxIncludedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration."
}

• Array of: object PriceAlteration
  An amount of money that modifies the price charged for an order item.

{
    "type":"array",
    "description":"A strucuture used to describe a price alteration.",
    "items":{
        "$ref":"#/components/schemas/PriceAlteration"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased."
}

• unit: string
  Currency (ISO4217 norm uses 3 letters to define the currency).
• value: number (float)
  A positive floating point number.

{
    "type":"object",
    "properties":{
        "unit":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency)."
        },
        "value":{
            "type":"number",
            "description":"A positive floating point number.",
            "format":"float"
        }
    },
    "description":"A base / value business entity used to represent money."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• applicationDuration: integer
  Duration during which the alteration applies on the order item price. (For example, 2 months free of charge for the recurring charge.)
• description: string
  A narrative that explains in detail the semantics of this order item price alteration.
• name: string
  Name of the order item price alteration.
• price(required): object Price
  Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
• priceType(required): string
  A category that describes the price such as recurring, one time and usage.
• priority: integer
  Priority level for applying this alteration among all the defined alterations on the order item price.
• productOfferingPrice: object ProductOfferingPriceRef
  ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
• recurringChargePeriod: string
  Could be month, week...
• unitOfMeasure: string
  Could be minutes, GB...

{
    "required":[
        "price",
        "priceType"
    ],
    "type":"object",
    "properties":{
        "applicationDuration":{
            "type":"integer",
            "description":"Duration during which the alteration applies on the order item price.  (For example, 2 months free of charge for the recurring charge.)"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail the semantics of this order item price alteration."
        },
        "name":{
            "type":"string",
            "description":"Name of the order item price alteration."
        },
        "priceType":{
            "type":"string",
            "description":"A category that describes the price such as recurring, one time and usage."
        },
        "priority":{
            "type":"integer",
            "description":"Priority level for applying this alteration among all the defined alterations on the order item price."
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Could be month, week..."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB..."
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        },
        "productOfferingPrice":{
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An amount of money that modifies the price charged for an order item."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  A name for the payment.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"A name for the payment."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"If an immediate payment has been done at the product order submission, the payment information is captured and stored (as a reference) in the order."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"It is a productOfferingQualification that has been executed previously."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• action(required): string
  Allowed Values: [ "add", "modify", "delete", "noChange", "suspend", "resume", "terminate" ]

  The action to be performed on the product.
• appointment: object AppointmentRef
  Refers an appointment, such as a Customer presentation or internal meeting or site visit.
• billingAccount: object BillingAccountRef
  BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
• id(required): string
  Identifier of the line item. (Generally, is a sequence number 01, 02, 03, ...)
• itemPrice: array itemPrice
• itemTerm: array itemTerm
• itemTotalPrice: array itemTotalPrice
• payment: array payment
• product: object ProductRefOrValue
  A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself.
• productOffering: object ProductOfferingRef
  ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
• productOfferingQualificationItem: object ProductOfferingQualificationItemRef
  It is a productOfferingQualification item that has been executed previously.
• productOrderItem: array productOrderItem
• productOrderItemRelationship: array productOrderItemRelationship
• qualification: array qualification
• quantity: integer
  Quantity ordered.
• quoteItem: object QuoteItemRef
  It is a Quote item that has been executed previously.
• state: string
  Allowed Values: [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation", "inProgress.fallout", "amending.fallout", "amending", "pendingCancellation.fallout" ]

  Possible values for the state of the product order item.

{
    "required":[
        "action",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the line item. (Generally, is a sequence number 01, 02, 03, ...)"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity ordered."
        },
        "action":{
            "$ref":"#/components/schemas/OrderItemActionType"
        },
        "appointment":{
            "$ref":"#/components/schemas/AppointmentRef"
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "itemPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderPrice"
            }
        },
        "itemTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderTerm"
            }
        },
        "itemTotalPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderPrice"
            }
        },
        "payment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PaymentRef"
            }
        },
        "product":{
            "$ref":"#/components/schemas/ProductRefOrValue"
        },
        "productOffering":{
            "$ref":"#/components/schemas/ProductOfferingRef"
        },
        "productOfferingQualificationItem":{
            "$ref":"#/components/schemas/ProductOfferingQualificationItemRef"
        },
        "productOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOrderItem"
            }
        },
        "productOrderItemRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderItemRelationship"
            }
        },
        "qualification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingQualificationRef"
            }
        },
        "quoteItem":{
            "$ref":"#/components/schemas/QuoteItemRef"
        },
        "state":{
            "$ref":"#/components/schemas/ProductOrderItemStateType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An identified part of the order. A product order is decomposed into one or more order items."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• description: string
  An explanatory text regarding the appointment made with a party.
• href: string
  The reference of the appointment.
• id(required): string
  The identifier of the referred appointment.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred appointment."
        },
        "href":{
            "type":"string",
            "description":"The reference of the appointment."
        },
        "description":{
            "type":"string",
            "description":"An explanatory text regarding the appointment made with a party."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Refers an appointment, such as a Customer presentation or internal meeting or site visit."
}

• Array of: object OrderPrice
  An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrderPrice"
    }
}

• Array of: object OrderTerm
  Description of a productTerm linked to this orderItem. This represents a commitment with a duration.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrderTerm"
    }
}

• Array of: object OrderPrice
  An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrderPrice"
    }
}

• Array of: object PaymentRef
  If an immediate payment has been done at the product order submission, the payment information is captured and stored (as a reference) in the order.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• agreement: array agreement
• billingAccount: object BillingAccountRef
  BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
• description: string
  Is the description of the product. It could be copied from the description of the Product Offering.
• href: string
  Reference of the product.
• id: string
  Unique identifier of the product.
• isBundle: boolean
  If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering.
• isCustomerVisible: boolean
  If true, the product is visible by the customer.
• name: string
  Name of the product. It could be the same as the name of the product offering.
• orderDate: string (date-time)
  The date when the product was ordered.
• place: array place
• product: array product
• productCharacteristic: array productCharacteristic
• productOffering: object ProductOfferingRef
  ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
• productOrderItem: array productOrderItem
• productPrice: array productPrice
• productRelationship: array productRelationship
• productSerialNumber: string
  The serial number for the product. This is typically applicable to tangible products. For example, Broadband Router.
• productSpecification: object ProductSpecificationRef
  Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
• productTerm: array productTerm
• realizingResource: array realizingResource
• realizingService: array realizingService
• relatedParty: array relatedParty
• startDate: string (date-time)
  The date from which the product starts.
• status: string
  Allowed Values: [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted " ]

  Possible values for the status of the product.
• terminationDate: string (date-time)
  The date when the product was terminated.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product."
        },
        "href":{
            "type":"string",
            "description":"Reference of the product."
        },
        "description":{
            "type":"string",
            "description":"Is the description of the product. It could be copied from the description of the Product Offering."
        },
        "isBundle":{
            "type":"boolean",
            "description":"If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering."
        },
        "isCustomerVisible":{
            "type":"boolean",
            "description":"If true, the product is visible by the customer."
        },
        "name":{
            "type":"string",
            "description":"Name of the product. It could be the same as the name of the product offering."
        },
        "orderDate":{
            "type":"string",
            "description":"The date when the product was ordered.",
            "format":"date-time"
        },
        "productSerialNumber":{
            "type":"string",
            "description":"The serial number for the product. This is typically applicable to tangible products. For example, Broadband Router."
        },
        "startDate":{
            "type":"string",
            "description":"The date from which the product starts.",
            "format":"date-time"
        },
        "terminationDate":{
            "type":"string",
            "description":"The date when the product was terminated.",
            "format":"date-time"
        },
        "agreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementItemRef"
            }
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
            }
        },
        "product":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRefOrValue"
            }
        },
        "productCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "productOffering":{
            "$ref":"#/components/schemas/ProductOfferingRef"
        },
        "productOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedProductOrderItem"
            }
        },
        "productPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductPrice"
            }
        },
        "productRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRelationship"
            }
        },
        "productSpecification":{
            "$ref":"#/components/schemas/ProductSpecificationRef"
        },
        "productTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductTerm"
            }
        },
        "realizingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        },
        "realizingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceRef"
            }
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "status":{
            "$ref":"#/components/schemas/ProductStatusType"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Id of an item of a product offering qualification.
• name: string
  Name of the related entity.
• productOfferingQualificationHref: string
  Reference of the related entity.
• productOfferingQualificationId(required): string
  Unique identifier of a related entity.
• productOfferingQualificationName: string
  Name of the related entity.

{
    "required":[
        "id",
        "productOfferingQualificationId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of an item of a product offering qualification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "productOfferingQualificationHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "productOfferingQualificationId":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "productOfferingQualificationName":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"It is a productOfferingQualification item that has been executed previously."
}

• Array of: object ProductOrderItem
  An identified part of the order. A product order is decomposed into one or more order items.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOrderItem"
    }
}

• Array of: object OrderItemRelationship

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrderItemRelationship"
    }
}

• Array of: object ProductOfferingQualificationRef
  It is a productOfferingQualification that has been executed previously.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingQualificationRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Id of an item of a quote.
• name: string
  Name of the related entity.
• quoteHref: string
  Reference of the related entity.
• quoteId(required): string
  Unique identifier of a related entity.
• quoteName: string
  Name of the related entity.

{
    "required":[
        "id",
        "quoteId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of an item of a quote."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "quoteHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "quoteId":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "quoteName":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"It is a Quote item that has been executed previously."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• description: string
  Description of the productOrderTerm.
• duration: object Quantity
  An amount in a given unit.
• name: string
  Name of the productOrderTerm.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the productOrderTerm."
        },
        "name":{
            "type":"string",
            "description":"Name of the productOrderTerm."
        },
        "duration":{
            "$ref":"#/components/schemas/Quantity"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Description of a productTerm linked to this orderItem. This represents a commitment with a duration."
}

• amount: number (float)
  Default Value: 1

  Numeric value in a given unit.
• units: string
  Unit

{
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"Numeric value in a given unit.",
            "format":"float",
            "default":1
        },
        "units":{
            "type":"string",
            "description":"Unit"
        }
    },
    "description":"An amount in a given unit."
}

• Array of: object AgreementItemRef
  Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementItemRef"
    }
}

• Array of: object RelatedPlaceRefOrValue
  Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
    }
}

• Array of: object ProductRefOrValue
  A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductRefOrValue"
    }
}

• Array of: object Characteristic
  Describes a given characteristic of an object or entity through a name/value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    }
}

• Array of: object RelatedProductOrderItem
  RelatedProductOrderItem (ProductOrder item). The product order item which triggered product creation, change, or termination.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedProductOrderItem"
    }
}

• Array of: object ProductPrice
  An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductPrice"
    }
}

• Array of: object ProductRelationship
  Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (For example, an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductRelationship"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.
• targetProductSchema: object TargetProductSchema
  The reference object to the schema and type of target product which is described by product specification.
• version: string
  Version of the product specification.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Version of the product specification."
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role."
}

• Array of: object ProductTerm
  Description of a productTerm linked to this product. This represents a commitment with a duration.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductTerm"
    }
}

• Array of: object ResourceRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

• Array of: object ServiceRef
  Service reference, for when Service is used by other entities.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceRef"
    }
}

• Array of: object RelatedParty
  Related Entity reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• agreementItemId: string
  Identifier of the agreement.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "agreementItemId":{
            "type":"string",
            "description":"Identifier of the agreement."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Unique reference of the place.
• id: string
  Unique identifier of the place.
• name: string
  A user-friendly name for place, such as [Paris Store], [London Store], [Main Home].
• role(required): string

{
    "required":[
        "role"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the place."
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the place."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for place, such as [Paris Store], [London Store], [Main Home]."
        },
        "role":{
            "type":"string"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• name(required): string
  Name of the characteristic.
• value(required): object Any
• valueType: string
  Data type of the value of the characteristic.

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"Data type of the value of the characteristic."
        },
        "value":{
            "$ref":"#/components/schemas/Any"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Describes a given characteristic of an object or entity through a name/value pair."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• orderItemAction: string
  Action of the order item for this product.
• orderItemId(required): string
  Identifier of the order item where the product was managed.
• productOrderHref: string
  Reference of the related entity.
• productOrderId(required): string
  Unique identifier of a related entity.
• role: string
  Role of the product order item for this product.

{
    "required":[
        "orderItemId",
        "productOrderId"
    ],
    "type":"object",
    "properties":{
        "orderItemAction":{
            "type":"string",
            "description":"Action of the order item for this product."
        },
        "orderItemId":{
            "type":"string",
            "description":"Identifier of the order item where the product was managed."
        },
        "productOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "productOrderId":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "role":{
            "type":"string",
            "description":"Role of the product order item for this product."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"RelatedProductOrderItem (ProductOrder item). The product order item which triggered product creation, change, or termination."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• billingAccount: object BillingAccountRef
  BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
• description: string
  A narrative that explains in detail the semantics of this product price.
• name: string
  A short descriptive name such as "Subscription price".
• price(required): object Price
  Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
• priceType(required): string
  A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.
• productOfferingPrice: object ProductOfferingPriceRef
  ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
• productPriceAlteration: array productPriceAlteration
• recurringChargePeriod: string
  Could be month, week...
• unitOfMeasure: string
  Could be minutes, GB...

{
    "required":[
        "price",
        "priceType"
    ],
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail the semantics of this product price."
        },
        "name":{
            "type":"string",
            "description":"A short descriptive name such as \"Subscription price\"."
        },
        "priceType":{
            "type":"string",
            "description":"A category that describes the price, such as recurring, discount, allowance, penalty, and so forth."
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Could be month, week..."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB..."
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        },
        "productOfferingPrice":{
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        "productPriceAlteration":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceAlteration"
            }
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time."
}

• Array of: object PriceAlteration
  An amount of money that modifies the price charged for an order item.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceAlteration"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• product(required): object ProductRefOrValue
  A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself.
• relationshipType(required): string
  Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (For example, an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful.

{
    "required":[
        "product",
        "relationshipType"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (For example, an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful."
        },
        "product":{
            "$ref":"#/components/schemas/ProductRefOrValue"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (For example, an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation(required): string
  This field provides a link to the schema describing the target. product
• @type(required): string
  Class type of the target product.

{
    "required":[
        "@schemaLocation",
        "@type"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing the target. product"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the target product."
        }
    },
    "description":"The reference object to the schema and type of target product which is described by product specification."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• description: string
  Description of the productTerm.
• duration: object Quantity
  An amount in a given unit.
• name: string
  Name of the productTerm.
• validFor: object TimePeriod
  A period of time, either as a deadline (endDateTime only) a startDateTime only, or both.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the productTerm."
        },
        "name":{
            "type":"string",
            "description":"Name of the productTerm."
        },
        "duration":{
            "$ref":"#/components/schemas/Quantity"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Description of a productTerm linked to this product. This represents a commitment with a duration."
}

• endDateTime: string (date-time)
  End of the time period, using IETC-RFC-3339 format.
• startDateTime: string (date-time)
  Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end.

{
    "type":"object",
    "properties":{
        "endDateTime":{
            "type":"string",
            "description":"End of the time period, using IETC-RFC-3339 format.",
            "format":"date-time"
        },
        "startDateTime":{
            "type":"string",
            "description":"Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end.",
            "format":"date-time"
        }
    },
    "description":"A period of time, either as a deadline (endDateTime only) a startDateTime only, or both."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the resource.
• value: string
  The resource value that can be used to identify a resource. with a public key (e.g.: a tel nr, an msisdn)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the resource."
        },
        "value":{
            "type":"string",
            "description":"The resource value that can be used to identify a resource. with a public key (e.g.: a tel nr, an msisdn)"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Service reference, for when Service is used by other entities."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType(required): string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.
• role: string
  Role played by the related party.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "role":{
            "type":"string",
            "description":"Role played by the related party."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Related Entity reference. A related party defines party or party role linked to a specific entity."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• id: string
• relationshipType: string
  The type of order item relationship.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "relationshipType":{
            "type":"string",
            "description":"The type of order item relationship."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"It is a Quote that has been executed previously."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}