• Array of: object PricelistOracle
  Title: PricelistOracle

  A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers

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

• @baseType: string
  Immediate base (class) type of the object
• @schemaLocation: string
  A link to the schema describing this object
• @type: string
  Class type of the object
• applicationName: string
  name of the external application
• balanceElement: object BalanceElementRef
  Title: BalanceElementRef

  Balance element ref in price
• businessUnitId: number
  Indicates Business Unit to which the offer belongs.
• businessUnitName: string
  Indicates name of Business Unit to which the offer belongs.
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• currency: string
  Currency (ISO4217 norm uses 3 letters to define the currency)
• description: string
  Description of the Pricelist
• externalId: string
  id of the external application
• href: string
  Reference of the Pricelist
• id: string
  Maximum Length: 30

  Unique identifier of the Pricelist
• lastUpdate: string (date-time)
  Date and time of the last update
• lastUpdatedBy: string
  name of the person who updated item
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name: string
  Name of the Pricelist
• pricelistType: string
  Allowed Values: [ "RESIDENTIAL", "BUSINESS" ]

  Indicates if the pricelist is a Residential, Business or other type of resource
• productOffering: array productOffering
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• promotion: array promotion
• relatedParty: array relatedParty
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  Promotion version
• versionState: number
  Version state of the price list

{
    "title":"PricelistOracle",
    "type":"object",
    "description":"A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the Pricelist"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Pricelist"
        },
        "name":{
            "type":"string",
            "description":"Name of the Pricelist"
        },
        "description":{
            "type":"string",
            "description":"Description of the Pricelist"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "pricelistType":{
            "type":"string",
            "description":"Indicates if the pricelist is a Residential, Business or other type of resource",
            "enum":[
                "RESIDENTIAL",
                "BUSINESS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the object"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "currency":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency)"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Promotion version"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            }
        },
        "promotion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PromotionRef"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the price list"
        },
        "businessUnitId":{
            "type":"number",
            "description":"Indicates Business Unit to which the offer belongs."
        },
        "businessUnitName":{
            "type":"string",
            "description":"Indicates name of Business Unit to which the offer belongs."
        }
    }
}

• @baseType: string
  Indicates the base (class) type of this REST resource
• @referredType: string
  The Class type of referred balance element
• @schemaLocation: string
  This field provides a link to the schema describing this REST resource
• @type: string
  Indicates the (class) type of balance element.
• href: string
  Unique reference of the balance element
• id(required): string
  Unique identifier of the balance element
• name: string
  Name of the balance element
• version: string
  Version of the balance element
• versionState: number
  To hold the version state of reference

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"Balance element ref in price",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the balance element"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the balance element"
        },
        "version":{
            "type":"string",
            "description":"Version of the balance element"
        },
        "name":{
            "type":"string",
            "description":"Name of the balance element"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of balance element."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred balance element"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id"
    ]
}

• Array of: object ProductOfferingRef
  Title: ProductOfferingRef

  ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

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

• href: string
  Unique reference of the project
• id(required): string
  Unique identifier of the project
• name: string
  Name of the project
• version: string
  Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

• Array of: object PromotionRef
  Title: PromotionRef

  Promotion reference.

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

• Array of: object RelatedParty
  Title: RelatedParty

  RelatedParty reference. A related party defines party or party role linked to a specific entity.

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

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime(required): string (date-time)
  An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    },
    "required":[
        "startDateTime"
    ]
}

• @baseType: string
  base class type (immediate parent) of the ProductOfferingRef
• @referredType: string
  the class type of the referred product offering
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type: string
  The class type of this ProductOfferingRef
• href: string
  Reference of the product offering
• id(required): string
  Unique identifier of the product offering
• name: string
  Name of the product offering
• versionState: number
  To hold the version state for the reference

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product offering"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product offering"
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this ProductOfferingRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductOfferingRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred product offering"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id"
    ]
}

• @baseType: string
  base class type (immediate parent) of the Promotion
• @referredType: string
  the class type of the referred Promotion
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type: string
  The class type of this Promotion
• href: string
  Reference of the Promotiong
• id(required): string
  Unique identifier of the Promotiong
• name: string
  Name of the Promotion

{
    "title":"PromotionRef",
    "type":"object",
    "description":"Promotion reference. ",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the Promotiong"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Promotiong"
        },
        "name":{
            "type":"string",
            "description":"Name of the Promotion"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this Promotion"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the Promotion"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred Promotion"
        }
    },
    "required":[
        "id"
    ]
}

• @baseType: string
  The immediate base class type of the RelatedParty
• @referredType: string
  The class type of referred party/party role reference
• @schemaLocation: string
  A link to the schema describing this RelatedParty entity
• @type: string
  the class type of the RelatedParty
• href: string
  Reference of the related party, could be a party reference or a party role reference
• id(required): string
  Unique identifier of a related party
• name: string
  Name of the related party
• role: string
  Role of the related party.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related party"
        },
        "href":{
            "type":"string",
            "description":"Reference of the related party, could be a party reference or a party role reference"
        },
        "role":{
            "type":"string",
            "description":"Role of the related party."
        },
        "name":{
            "type":"string",
            "description":"Name of the related party"
        },
        "@referredType":{
            "type":"string",
            "description":"The class type of referred party/party role reference"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the RelatedParty"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the RelatedParty"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this RelatedParty entity"
        }
    },
    "required":[
        "id"
    ]
}

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/Error"
            },
            {
                "$ref":"#/components/schemas/BulkError"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "Error":"#/components/schemas/Error",
                "BulkError":"#/components/schemas/BulkError"
            }
        }
    }
}

Discriminator Values

• Error
• BulkError

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

• @schemaLocation: string
  It provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

• @schemaLocation: string
  It provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

• @schemaLocation: string
  It provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

• @schemaLocation: string
  It provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}