• BillingAccount
• BillingAccountOracle

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillingAccount"
        },
        {
            "$ref":"#/components/schemas/BillingAccountOracle"
        }
    ]
}

• allOf PartyAccount
• object BillingAccount-allOf[1]
  The party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of Party Account entity.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PartyAccount"
        },
        {
            "type":"object",
            "description":"The party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of Party Account entity.",
            "properties":{
                "ratingType":{
                    "type":"string",
                    "description":"The indication for whether the account follows a specific payment option such as prepaid or postpaid."
                }
            }
        }
    ]
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object BillingAccountOracle-allOf[1]
  A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"Hyperlink reference"
                },
                "id":{
                    "type":"string",
                    "description":"unique identifier"
                },
                "accountNum":{
                    "type":"string",
                    "description":"The account number."
                },
                "description":{
                    "type":"string",
                    "description":"Detailed description of the account"
                },
                "name":{
                    "type":"string",
                    "description":"Name of the account"
                },
                "state":{
                    "type":"string",
                    "enum":[
                        "active",
                        "inactive",
                        "closed"
                    ],
                    "description":"The lifecycle state&colon; <b>active</b>, <b>inactive</b>, or <b>closed</b>."
                },
                "accountType":{
                    "type":"string",
                    "enum":[
                        "unknown",
                        "consumer",
                        "business"
                    ],
                    "description":"The account categorization whose instances share some of the same characteristics, such as <b>unknown</b>, <b>consumer</b>, or <b>business</b>. <p><b>Note&colon;</b> For flexibility, we use a string here but an implementation may use an enumeration with a limited list of valid values."
                },
                "brmAccountType":{
                    "type":"string",
                    "enum":[
                        "standard",
                        "brand"
                    ],
                    "description":"The type of BRM account&colon; <b>standard</b> or <b>brand</b>."
                },
                "glSegment":{
                    "type":"string",
                    "description":"The GL segment value."
                },
                "currency":{
                    "type":"string",
                    "description":"The currency. The ISO4217 norm uses 3 letters to define the currency."
                },
                "currencySecondary":{
                    "type":"string",
                    "description":"The currency. The ISO4217 norm uses 3 letters to define the currency."
                },
                "customerSegmentList":{
                    "type":"string",
                    "description":"The customer segment list."
                },
                "locale":{
                    "type":"string",
                    "description":"The language. The default value is <b>en_US</b>."
                },
                "vatCertificate":{
                    "type":"string",
                    "description":"The VAT certificate."
                },
                "attribute":{
                    "type":"integer",
                    "description":"The attribute name."
                },
                "billStructure":{
                    "$ref":"#/components/schemas/BillStructureOracle"
                },
                "serviceBillStructure":{
                    "$ref":"#/components/schemas/ServiceBillStructureOracle"
                },
                "relatedParty":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RelatedPartyOracle"
                    },
                    "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
                },
                "taxExemption":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TaxExemptionCertificateOracle"
                    },
                    "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
                },
                "contact":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContactOracle"
                    },
                    "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
                },
                "accountRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AccountRelationshipOracle"
                    },
                    "description":"The list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
                }
            }
        }
    ]
}

• allOf Account
• object PartyAccount-allOf[1]
  The account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Account"
        },
        {
            "type":"object",
            "description":"The account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.",
            "properties":{
                "billStructure":{
                    "$ref":"#/components/schemas/BillStructure"
                }
            }
        }
    ]
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object Account-allOf[1]
  The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.",
            "properties":{
                "creditLimit":{
                    "$ref":"#/components/schemas/Money"
                },
                "description":{
                    "type":"string",
                    "description":"The detailed description of the account."
                },
                "lastUpdate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time that the account was last updated."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the account."
                },
                "state":{
                    "type":"string",
                    "description":"The attribute contains the lifecycle state, such as <b>Active</b>, <b>Closed</b>, <b>Suspended</b>, and so on."
                },
                "accountType":{
                    "type":"string",
                    "description":"The categorization of an account, such as individual or joint, that defines shared characteristics."
                },
                "relatedParty":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
                    },
                    "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
                },
                "taxExemption":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TaxExemptionCertificate"
                    },
                    "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
                },
                "contact":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Contact"
                    },
                    "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
                },
                "accountBalance":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AccountBalance"
                    },
                    "description":"The list of balances for the account, such as regular postpaid balance, deposit balance, or write-off balance."
                },
                "accountRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AccountRelationship"
                    },
                    "description":"A list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
                }
            }
        }
    ]
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Addressable
  The base schema for adressable entities.

{
    "type":"object",
    "description":"The Base entity schema for use in TMForum Open-APIs Property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        }
    ]
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• href: string
  The hyperlink reference.
• id: string
  The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

• accountBalance: array accountBalance
  The list of balances for the account, such as regular postpaid balance, deposit balance, or write-off balance.
• accountRelationship: array accountRelationship
  A list of balances related to the account. For example, a list of billing accounts that contribute to a financial account.
• accountType: string
  The categorization of an account, such as individual or joint, that defines shared characteristics.
• contact: array contact
  The list of people who could be contacted regarding the account, such as the accountant who authorizes payments.
• creditLimit: object Money
  The base / value business entity used to represent money.
• description: string
  The detailed description of the account.
• lastUpdate: string (date-time)
  The date and time that the account was last updated.
• name: string
  The name of the account.
• relatedParty: array relatedParty
  The list of parties that have some relationship with the account, such as the customer to whom the account belongs.
• state: string
  The attribute contains the lifecycle state, such as Active, Closed, Suspended, and so on.
• taxExemption: array taxExemption
  The list of tax exemptions that can be applied when calculating charges levied to the account.

{
    "type":"object",
    "description":"The generic account structure defines common elements for account types, including PartyAccount and other accounts supported by the API.",
    "properties":{
        "creditLimit":{
            "$ref":"#/components/schemas/Money"
        },
        "description":{
            "type":"string",
            "description":"The detailed description of the account."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that the account was last updated."
        },
        "name":{
            "type":"string",
            "description":"The name of the account."
        },
        "state":{
            "type":"string",
            "description":"The attribute contains the lifecycle state, such as <b>Active</b>, <b>Closed</b>, <b>Suspended</b>, and so on."
        },
        "accountType":{
            "type":"string",
            "description":"The categorization of an account, such as individual or joint, that defines shared characteristics."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
        },
        "taxExemption":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxExemptionCertificate"
            },
            "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
        },
        "contact":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Contact"
            },
            "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
        },
        "accountBalance":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AccountBalance"
            },
            "description":"The list of balances for the account, such as regular postpaid balance, deposit balance, or write-off balance."
        },
        "accountRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AccountRelationship"
            },
            "description":"A list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
        }
    }
}

• billStructure: BillStructure

{
    "type":"object",
    "description":"The account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.",
    "properties":{
        "billStructure":{
            "$ref":"#/components/schemas/BillStructure"
        }
    }
}

• ratingType: string
  The indication for whether the account follows a specific payment option such as prepaid or postpaid.

{
    "type":"object",
    "description":"The party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of Party Account entity.",
    "properties":{
        "ratingType":{
            "type":"string",
            "description":"The indication for whether the account follows a specific payment option such as prepaid or postpaid."
        }
    }
}

• Array of: AccountBalance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AccountBalance"
    },
    "description":"The list of balances for the account, such as regular postpaid balance, deposit balance, or write-off balance."
}

• Array of: AccountRelationship

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AccountRelationship"
    },
    "description":"A list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
}

• Array of: Contact

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Contact"
    },
    "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
}

• unit: string
  The currency (ISO4217 norm uses 3 letters to define the currency).
• value: number (double)
  The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type

{
    "type":"object",
    "description":"The base / value business entity used to represent money.",
    "properties":{
        "unit":{
            "type":"string",
            "description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
        },
        "value":{
            "type":"number",
            "format":"double",
            "description":"The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type"
        }
    }
}

• Array of: RelatedPartyRefOrPartyRoleRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
    },
    "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
}

• Array of: TaxExemptionCertificate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxExemptionCertificate"
    },
    "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object AccountBalance-allOf[1]
  The balances linked to the account.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The balances linked to the account.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the balance within the list of balances."
                },
                "amount":{
                    "$ref":"#/components/schemas/Money"
                },
                "balanceType":{
                    "type":"string",
                    "description":"The type of the balance, for example, deposit balance, disputed balance, loyalty balance, receivable balance."
                },
                "validFor":{
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "grantedBal":{
                    "type":"string",
                    "description":"The granted balance."
                },
                "nextBal":{
                    "type":"string",
                    "description":"The next balance."
                },
                "delayedBal":{
                    "type":"string",
                    "description":"The delayed balance."
                }
            }
        }
    ]
}

• amount: object Money
  The base / value business entity used to represent money.
• balanceType: string
  The type of the balance, for example, deposit balance, disputed balance, loyalty balance, receivable balance.
• delayedBal: string
  The delayed balance.
• grantedBal: string
  The granted balance.
• id: string
  The identifier of the balance within the list of balances.
• nextBal: string
  The next balance.
• validFor: object TimePeriod
  The period of time, as a deadline (endDateTime only), a startDateTime only, or both.

{
    "type":"object",
    "description":"The balances linked to the account.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the balance within the list of balances."
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "balanceType":{
            "type":"string",
            "description":"The type of the balance, for example, deposit balance, disputed balance, loyalty balance, receivable balance."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "grantedBal":{
            "type":"string",
            "description":"The granted balance."
        },
        "nextBal":{
            "type":"string",
            "description":"The next balance."
        },
        "delayedBal":{
            "type":"string",
            "description":"The delayed balance."
        }
    }
}

• endDateTime: string (date-time)
  The end of the time period, using IETC-RFC-3339 format.

  Example: 1985-04-12T23:20:50.52Z
• startDateTime: string (date-time)
  The start of the time period, using IETC-RFC-3339 format.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "description":"The period of time, as a deadline (endDateTime only), a startDateTime only, or both.",
    "properties":{
        "startDateTime":{
            "description":"The start of the time period, using IETC-RFC-3339 format.",
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        },
        "endDateTime":{
            "description":"The end of the time period, using IETC-RFC-3339 format.",
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object AccountRelationship-allOf[1]
  The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.",
            "properties":{
                "relationshipType":{
                    "type":"string",
                    "description":"The type of relationship."
                },
                "account":{
                    "$ref":"#/components/schemas/AccountRef"
                }
            }
        }
    ]
}

• account: object AccountRef
  The account reference. An account may be a party account or a financial account.
• relationshipType: string
  The type of relationship.

{
    "type":"object",
    "description":"The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship."
        },
        "account":{
            "$ref":"#/components/schemas/AccountRef"
        }
    }
}

• allOf EntityRef

{
    "type":"object",
    "description":"The account reference. An account may be a party account or a financial account.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Addressable
  The base schema for adressable entities.
• object EntityRef-allOf[2]
  The entity reference schema to be used for all entityRef class.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"The entity reference schema to be used for all entityRef class.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the referred entity."
                },
                "@referredType":{
                    "type":"string",
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The name of the referred entity.

{
    "type":"object",
    "description":"The entity reference schema to be used for all entityRef class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "description":"The name of the referred entity."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Contact-allOf[1]
  The individual or organization used as a contact point for a given account and accessed via some contact medium.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The individual or organization used as a contact point for a given account and accessed via some contact medium.",
            "properties":{
                "contactName":{
                    "type":"string",
                    "description":"The displayable name for the contact."
                },
                "contactType":{
                    "type":"string",
                    "description":"The type of contact, such as primary or secondary."
                },
                "contactMedium":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContactMedium"
                    },
                    "description":"The list of contact mediums for the contact, such as mobile phone number and email addresses."
                }
            }
        }
    ]
}

• contactMedium: array contactMedium
  The list of contact mediums for the contact, such as mobile phone number and email addresses.
• contactName: string
  The displayable name for the contact.
• contactType: string
  The type of contact, such as primary or secondary.

{
    "type":"object",
    "description":"The individual or organization used as a contact point for a given account and accessed via some contact medium.",
    "properties":{
        "contactName":{
            "type":"string",
            "description":"The displayable name for the contact."
        },
        "contactType":{
            "type":"string",
            "description":"The type of contact, such as primary or secondary."
        },
        "contactMedium":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactMedium"
            },
            "description":"The list of contact mediums for the contact, such as mobile phone number and email addresses."
        }
    }
}

• Array of: ContactMedium

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactMedium"
    },
    "description":"The list of contact mediums for the contact, such as mobile phone number and email addresses."
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object ContactMedium-allOf[1]
  The contact medium that could be used to contact the party.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The contact medium that could be used to contact the party.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier for this contact medium."
                }
            }
        }
    ]
}

• id: string
  The identifier for this contact medium.

{
    "type":"object",
    "description":"The contact medium that could be used to contact the party.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier for this contact medium."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object RelatedPartyRefOrPartyRoleRef-allOf[1]
  The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity",
            "properties":{
                "role":{
                    "description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer',  'salesAgent', 'user'",
                    "type":"string"
                },
                "partyOrPartyRole":{
                    "$ref":"#/components/schemas/PartyRefOrPartyRoleRef"
                }
            }
        }
    ]
}

• partyOrPartyRole: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } }

  The reference allows either a party or a party role to be specified.
• role: string
  The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'

{
    "type":"object",
    "description":"The RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity",
    "properties":{
        "role":{
            "description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer',  'salesAgent', 'user'",
            "type":"string"
        },
        "partyOrPartyRole":{
            "$ref":"#/components/schemas/PartyRefOrPartyRoleRef"
        }
    }
}

Discriminator Values

• PartyRef
• PartyRoleRef

{
    "type":"object",
    "description":"The reference allows either a party or a party role to be specified.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PartyRef"
        },
        {
            "$ref":"#/components/schemas/PartyRoleRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PartyRef":"#/components/schemas/PartyRef",
            "PartyRoleRef":"#/components/schemas/PartyRoleRef"
        }
    }
}

• object PartyRef
  A party reference.
• PartyRoleRef

{
    "type":"object",
    "description":"The reference allows either a party or a party role to be specified.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PartyRef"
        },
        {
            "$ref":"#/components/schemas/PartyRoleRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PartyRef":"#/components/schemas/PartyRef",
            "PartyRoleRef":"#/components/schemas/PartyRoleRef"
        }
    }
}

• allOf EntityRef

{
    "type":"object",
    "description":"A party reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

• allOf EntityRef
• object PartyRoleRef-allOf[1]
  The Party Role reference. A party role represents the part played by a party in a given context.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"The Party Role reference. A party role represents the part played by a party in a given context.",
            "properties":{
                "partyId":{
                    "type":"string",
                    "description":"The identifier of the engaged party that is linked to the PartyRole object."
                },
                "partyName":{
                    "type":"string",
                    "description":"The name of the engaged party that is linked to the PartyRole object."
                }
            }
        }
    ]
}

• partyId: string
  The identifier of the engaged party that is linked to the PartyRole object.
• partyName: string
  The name of the engaged party that is linked to the PartyRole object.

{
    "type":"object",
    "description":"The Party Role reference. A party role represents the part played by a party in a given context.",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"The identifier of the engaged party that is linked to the PartyRole object."
        },
        "partyName":{
            "type":"string",
            "description":"The name of the engaged party that is linked to the PartyRole object."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object TaxExemptionCertificate-allOf[1]
  The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the tax exemption within list of the exemptions."
                },
                "taxDefinition":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TaxDefinition"
                    },
                    "description":"The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
                },
                "validFor":{
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "certificateNumber":{
                    "type":"string",
                    "description":"The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction."
                },
                "issuingJurisdiction":{
                    "type":"string",
                    "description":"The name of the jurisdiction that issued the exemption.",
                    "example":"USA"
                },
                "reason":{
                    "type":"string",
                    "description":"The reason for the tax exemption."
                },
                "attachment":{
                    "$ref":"#/components/schemas/AttachmentRefOrValue"
                }
            }
        }
    ]
}

• attachment: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentRef":"#/components/schemas/AttachmentRef" } }

  The polymorphic attributes @type, @schemaLocation, and @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself.
• certificateNumber: string
  The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction.
• id: string
  The identifier of the tax exemption within list of the exemptions.
• issuingJurisdiction: string
  The name of the jurisdiction that issued the exemption.

  Example: USA
• reason: string
  The reason for the tax exemption.
• taxDefinition: array taxDefinition
  The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%).
• validFor: object TimePeriod
  The period of time, as a deadline (endDateTime only), a startDateTime only, or both.

{
    "type":"object",
    "description":"The tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the tax exemption within list of the exemptions."
        },
        "taxDefinition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxDefinition"
            },
            "description":"The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "certificateNumber":{
            "type":"string",
            "description":"The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction."
        },
        "issuingJurisdiction":{
            "type":"string",
            "description":"The name of the jurisdiction that issued the exemption.",
            "example":"USA"
        },
        "reason":{
            "type":"string",
            "description":"The reason for the tax exemption."
        },
        "attachment":{
            "$ref":"#/components/schemas/AttachmentRefOrValue"
        }
    }
}

Discriminator Values

• Attachment
• AttachmentRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation, and @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Attachment"
        },
        {
            "$ref":"#/components/schemas/AttachmentRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Attachment":"#/components/schemas/Attachment",
            "AttachmentRef":"#/components/schemas/AttachmentRef"
        }
    }
}

• Attachment
• AttachmentRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation, and @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Attachment"
        },
        {
            "$ref":"#/components/schemas/AttachmentRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Attachment":"#/components/schemas/Attachment",
            "AttachmentRef":"#/components/schemas/AttachmentRef"
        }
    }
}

• Array of: TaxDefinition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxDefinition"
    },
    "description":"The list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object Attachment-allOf[1]
  The complementary description of an element (for instance a product) through video, pictures, etc.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The complementary description of an element (for instance a product) through video, pictures, etc.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the attachment."
                },
                "description":{
                    "type":"string",
                    "description":"The narrative text describing the content of the attachment.",
                    "example":"Photograph of the Product"
                },
                "url":{
                    "type":"string",
                    "description":"The Uniform Resource Locator is a web page address (a subset of URI).",
                    "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f"
                },
                "content":{
                    "type":"string",
                    "format":"base64",
                    "description":"The actual contents of the attachment object, if embedded, encoded as base64."
                },
                "size":{
                    "$ref":"#/components/schemas/Quantity"
                },
                "validFor":{
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "attachmentType":{
                    "type":"string",
                    "description":"The business characterization of the purpose of the attachment, for example, the logo, instructionManual, contractCopy."
                },
                "mimeType":{
                    "type":"string",
                    "description":"The technical characterization of the attachment content format using IETF Mime Types."
                }
            }
        }
    ]
}

• allOf EntityRef
• object AttachmentRef-allOf[1]
  The attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"The attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures.",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"The narrative text describing the content of the attachment."
                },
                "url":{
                    "description":"The link to the attachment media/content.",
                    "type":"string"
                }
            }
        }
    ]
}

• attachmentType: string
  The business characterization of the purpose of the attachment, for example, the logo, instructionManual, contractCopy.
• content: string (base64)
  The actual contents of the attachment object, if embedded, encoded as base64.
• description: string
  The narrative text describing the content of the attachment.

  Example: Photograph of the Product
• mimeType: string
  The technical characterization of the attachment content format using IETF Mime Types.
• name: string
  The name of the attachment.
• size: object Quantity
  The amount in a given unit.
• url: string
  The Uniform Resource Locator is a web page address (a subset of URI).

  Example: http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f
• validFor: object TimePeriod
  The period of time, as a deadline (endDateTime only), a startDateTime only, or both.

{
    "type":"object",
    "description":"The complementary description of an element (for instance a product) through video, pictures, etc.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the attachment."
        },
        "description":{
            "type":"string",
            "description":"The narrative text describing the content of the attachment.",
            "example":"Photograph of the Product"
        },
        "url":{
            "type":"string",
            "description":"The Uniform Resource Locator is a web page address (a subset of URI).",
            "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f"
        },
        "content":{
            "type":"string",
            "format":"base64",
            "description":"The actual contents of the attachment object, if embedded, encoded as base64."
        },
        "size":{
            "$ref":"#/components/schemas/Quantity"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "attachmentType":{
            "type":"string",
            "description":"The business characterization of the purpose of the attachment, for example, the logo, instructionManual, contractCopy."
        },
        "mimeType":{
            "type":"string",
            "description":"The technical characterization of the attachment content format using IETF Mime Types."
        }
    }
}

• amount: number (double)
  Default Value: 1

  The numeric value in a given unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"The amount in a given unit.",
    "properties":{
        "amount":{
            "type":"number",
            "format":"double",
            "default":1,
            "description":"The numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"The unit."
        }
    }
}

• description: string
  The narrative text describing the content of the attachment.
• url: string
  The link to the attachment media/content.

{
    "type":"object",
    "description":"The attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures.",
    "properties":{
        "description":{
            "type":"string",
            "description":"The narrative text describing the content of the attachment."
        },
        "url":{
            "description":"The link to the attachment media/content.",
            "type":"string"
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object TaxDefinition-allOf[1]
  The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The unique identifier of the tax."
                },
                "name":{
                    "type":"string",
                    "description":"The tax name."
                },
                "validFor":{
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "jurisdictionName":{
                    "type":"string",
                    "description":"The name of the jurisdiction that levies the tax.",
                    "example":"USA"
                },
                "jurisdictionLevel":{
                    "type":"string",
                    "description":"The level of the jurisdiction that levies the tax.",
                    "example":"Country"
                },
                "taxType":{
                    "type":"string",
                    "description":"The type of the tax.",
                    "example":"VAT"
                },
                "percent":{
                    "type":"integer",
                    "description":"The tax percent."
                },
                "issuingJurisdiction":{
                    "type":"string",
                    "description":"The jurisdiction that issues the tax."
                },
                "certificateNumber":{
                    "type":"string",
                    "description":"The certificate number."
                },
                "reason":{
                    "type":"string",
                    "description":"The tax reason."
                }
            }
        }
    ]
}

• certificateNumber: string
  The certificate number.
• id: string
  The unique identifier of the tax.
• issuingJurisdiction: string
  The jurisdiction that issues the tax.
• jurisdictionLevel: string
  The level of the jurisdiction that levies the tax.

  Example: Country
• jurisdictionName: string
  The name of the jurisdiction that levies the tax.

  Example: USA
• name: string
  The tax name.
• percent: integer
  The tax percent.
• reason: string
  The tax reason.
• taxType: string
  The type of the tax.

  Example: VAT
• validFor: object TimePeriod
  The period of time, as a deadline (endDateTime only), a startDateTime only, or both.

{
    "type":"object",
    "description":"The reference of a tax definition. A tax is levied by an authorized tax jurisdiction. For example, there are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California, City Tax levied by the City of Los Angeles, etc.).",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the tax."
        },
        "name":{
            "type":"string",
            "description":"The tax name."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "jurisdictionName":{
            "type":"string",
            "description":"The name of the jurisdiction that levies the tax.",
            "example":"USA"
        },
        "jurisdictionLevel":{
            "type":"string",
            "description":"The level of the jurisdiction that levies the tax.",
            "example":"Country"
        },
        "taxType":{
            "type":"string",
            "description":"The type of the tax.",
            "example":"VAT"
        },
        "percent":{
            "type":"integer",
            "description":"The tax percent."
        },
        "issuingJurisdiction":{
            "type":"string",
            "description":"The jurisdiction that issues the tax."
        },
        "certificateNumber":{
            "type":"string",
            "description":"The certificate number."
        },
        "reason":{
            "type":"string",
            "description":"The tax reason."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object BillStructure-allOf[1]
  The structure of the bill for party accounts (billing or settlement).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The structure of the bill for party accounts (billing or settlement).",
            "properties":{
                "presentationMedia":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/BillPresentationMediaRefOrValue"
                    }
                },
                "format":{
                    "$ref":"#/components/schemas/BillFormatRefOrValue"
                },
                "cycleSpecification":{
                    "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValue"
                }
            }
        }
    ]
}

• cycleSpecification: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } }

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself
• format: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } }

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself
• presentationMedia: array presentationMedia

{
    "type":"object",
    "description":"The structure of the bill for party accounts (billing or settlement).",
    "properties":{
        "presentationMedia":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillPresentationMediaRefOrValue"
            }
        },
        "format":{
            "$ref":"#/components/schemas/BillFormatRefOrValue"
        },
        "cycleSpecification":{
            "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValue"
        }
    }
}

Discriminator Values

• BillingCycleSpecification
• BillingCycleSpecificationRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillingCycleSpecification"
        },
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification",
            "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef"
        }
    }
}

• BillingCycleSpecification
• object BillingCycleSpecificationRef
  BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillingCycleSpecification"
        },
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification",
            "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef"
        }
    }
}

Discriminator Values

• BillFormat
• BillFormatRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillFormat"
        },
        {
            "$ref":"#/components/schemas/BillFormatRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillFormat":"#/components/schemas/BillFormat",
            "BillFormatRef":"#/components/schemas/BillFormatRef"
        }
    }
}

• BillFormat
• object BillFormatRef
  The BillFormat reference. A bill format is a description of the way in which a bill is presented.

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillFormat"
        },
        {
            "$ref":"#/components/schemas/BillFormatRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillFormat":"#/components/schemas/BillFormat",
            "BillFormatRef":"#/components/schemas/BillFormatRef"
        }
    }
}

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

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself

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

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object BillingCycleSpecification-allOf[1]
  The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The short descriptive name"
                },
                "billingDateShift":{
                    "type":"integer",
                    "description":"The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period."
                },
                "description":{
                    "type":"string",
                    "description":"An explanation regarding this billing cycle specification."
                },
                "frequency":{
                    "type":"string",
                    "description":"Frequency of the billing cycle (monthly for instance)"
                },
                "paymentDueDateOffset":{
                    "type":"integer",
                    "description":"An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod."
                }
            }
        }
    ]
}

• allOf EntityRef

{
    "type":"object",
    "description":"BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

• billingDateShift: integer
  The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
• description: string
  An explanation regarding this billing cycle specification.
• frequency: string
  Frequency of the billing cycle (monthly for instance)
• name: string
  The short descriptive name
• paymentDueDateOffset: integer
  An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.

{
    "type":"object",
    "description":"The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The short descriptive name"
        },
        "billingDateShift":{
            "type":"integer",
            "description":"The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period."
        },
        "description":{
            "type":"string",
            "description":"An explanation regarding this billing cycle specification."
        },
        "frequency":{
            "type":"string",
            "description":"Frequency of the billing cycle (monthly for instance)"
        },
        "paymentDueDateOffset":{
            "type":"integer",
            "description":"An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod."
        }
    }
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object BillFormat-allOf[1]
  The detailed description of the way in which a bill is presented.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The detailed description of the way in which a bill is presented.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The short descriptive name."
                },
                "description":{
                    "type":"string",
                    "description":"The explanatory text for this bill format."
                }
            }
        }
    ]
}

• allOf EntityRef

{
    "type":"object",
    "description":"The BillFormat reference. A bill format is a description of the way in which a bill is presented.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

• description: string
  The explanatory text for this bill format.
• name: string
  The short descriptive name.

{
    "type":"object",
    "description":"The detailed description of the way in which a bill is presented.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The short descriptive name."
        },
        "description":{
            "type":"string",
            "description":"The explanatory text for this bill format."
        }
    }
}

Discriminator Values

• BillPresentationMedia
• BillPresentationMediaRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillPresentationMedia"
        },
        {
            "$ref":"#/components/schemas/BillPresentationMediaRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillPresentationMedia":"#/components/schemas/BillPresentationMedia",
            "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef"
        }
    }
}

• BillPresentationMedia
• object BillPresentationMediaRef
  The PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillPresentationMedia"
        },
        {
            "$ref":"#/components/schemas/BillPresentationMediaRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillPresentationMedia":"#/components/schemas/BillPresentationMedia",
            "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef"
        }
    }
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object BillPresentationMedia-allOf[1]
  The mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The short descriptive name."
                },
                "description":{
                    "type":"string",
                    "description":"The explanatory text describing this bill presentation media."
                }
            }
        }
    ]
}

• allOf EntityRef

{
    "type":"object",
    "description":"The PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

• description: string
  The explanatory text describing this bill presentation media.
• name: string
  The short descriptive name.

{
    "type":"object",
    "description":"The mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The short descriptive name."
        },
        "description":{
            "type":"string",
            "description":"The explanatory text describing this bill presentation media."
        }
    }
}

• accountNum: string
  The account number.
• accountRelationship: array accountRelationship
  The list of balances related to the account. For example, a list of billing accounts that contribute to a financial account.
• accountType: string
  Allowed Values: [ "unknown", "consumer", "business" ]

  The account categorization whose instances share some of the same characteristics, such as unknown, consumer, or business.

  Note: For flexibility, we use a string here but an implementation may use an enumeration with a limited list of valid values.

• attribute: integer
  The attribute name.
• billStructure: BillStructureOracle
• brmAccountType: string
  Allowed Values: [ "standard", "brand" ]

  The type of BRM account: standard or brand.
• contact: array contact
  The list of people who could be contacted regarding the account, such as the accountant who authorizes payments.
• currency: string
  The currency. The ISO4217 norm uses 3 letters to define the currency.
• currencySecondary: string
  The currency. The ISO4217 norm uses 3 letters to define the currency.
• customerSegmentList: string
  The customer segment list.
• description: string
  Detailed description of the account
• glSegment: string
  The GL segment value.
• href: string
  Hyperlink reference
• id: string
  unique identifier
• locale: string
  The language. The default value is en_US.
• name: string
  Name of the account
• relatedParty: array relatedParty
  The list of parties that have some relationship with the account, such as the customer to whom the account belongs.
• serviceBillStructure: array ServiceBillStructureOracle
  Array of Bill Structures
• state: string
  Allowed Values: [ "active", "inactive", "closed" ]

  The lifecycle state: active, inactive, or closed.
• taxExemption: array taxExemption
  The list of tax exemptions that can be applied when calculating charges levied to the account.
• vatCertificate: string
  The VAT certificate.

{
    "type":"object",
    "description":"A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.",
    "properties":{
        "href":{
            "type":"string",
            "description":"Hyperlink reference"
        },
        "id":{
            "type":"string",
            "description":"unique identifier"
        },
        "accountNum":{
            "type":"string",
            "description":"The account number."
        },
        "description":{
            "type":"string",
            "description":"Detailed description of the account"
        },
        "name":{
            "type":"string",
            "description":"Name of the account"
        },
        "state":{
            "type":"string",
            "enum":[
                "active",
                "inactive",
                "closed"
            ],
            "description":"The lifecycle state&colon; <b>active</b>, <b>inactive</b>, or <b>closed</b>."
        },
        "accountType":{
            "type":"string",
            "enum":[
                "unknown",
                "consumer",
                "business"
            ],
            "description":"The account categorization whose instances share some of the same characteristics, such as <b>unknown</b>, <b>consumer</b>, or <b>business</b>. <p><b>Note&colon;</b> For flexibility, we use a string here but an implementation may use an enumeration with a limited list of valid values."
        },
        "brmAccountType":{
            "type":"string",
            "enum":[
                "standard",
                "brand"
            ],
            "description":"The type of BRM account&colon; <b>standard</b> or <b>brand</b>."
        },
        "glSegment":{
            "type":"string",
            "description":"The GL segment value."
        },
        "currency":{
            "type":"string",
            "description":"The currency. The ISO4217 norm uses 3 letters to define the currency."
        },
        "currencySecondary":{
            "type":"string",
            "description":"The currency. The ISO4217 norm uses 3 letters to define the currency."
        },
        "customerSegmentList":{
            "type":"string",
            "description":"The customer segment list."
        },
        "locale":{
            "type":"string",
            "description":"The language. The default value is <b>en_US</b>."
        },
        "vatCertificate":{
            "type":"string",
            "description":"The VAT certificate."
        },
        "attribute":{
            "type":"integer",
            "description":"The attribute name."
        },
        "billStructure":{
            "$ref":"#/components/schemas/BillStructureOracle"
        },
        "serviceBillStructure":{
            "$ref":"#/components/schemas/ServiceBillStructureOracle"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyOracle"
            },
            "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
        },
        "taxExemption":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxExemptionCertificateOracle"
            },
            "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
        },
        "contact":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactOracle"
            },
            "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
        },
        "accountRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AccountRelationshipOracle"
            },
            "description":"The list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
        }
    }
}

• Array of: AccountRelationshipOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AccountRelationshipOracle"
    },
    "description":"The list of balances related to the account. For example, a list of billing accounts that contribute to a financial account."
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object BillStructureOracle-allOf[1]
  The structure of the bill for party accounts (billing or settlement).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The structure of the bill for party accounts (billing or settlement).",
            "properties":{
                "presentationMedia":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/BillPresentationMediaRefOrValue"
                    }
                },
                "format":{
                    "$ref":"#/components/schemas/BillFormatRefOrValue"
                },
                "cycleSpecification":{
                    "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValueOracle"
                },
                "id":{
                    "type":"string",
                    "description":"The bill unit ID."
                },
                "businessProfileId":{
                    "type":"string",
                    "description":"The business profile ID."
                },
                "actgType":{
                    "type":"string",
                    "enum":[
                        "open_items",
                        "balance_forward"
                    ],
                    "description":"The accounting type&colon; <b>open_items</b> or <b>balance_forward</b>."
                },
                "payType":{
                    "type":"string",
                    "enum":[
                        "invoice",
                        "credit_card",
                        "direct_debit",
                        "subordinate"
                    ],
                    "description":"The pay type&colon; <b>invoice</b>, <b>credit_card</b>, <b>direct_debit</b>, or <b>subordinate</b>."
                },
                "billingSegment":{
                    "type":"string",
                    "description":"The billing segment of bill structure."
                },
                "acctSuppressed":{
                    "type":"boolean",
                    "description":"The accepted values are true and false."
                },
                "name":{
                    "type":"string",
                    "description":"The bill unit name."
                },
                "balanceGroup":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "limit":{
                                "type":"array",
                                "items":{
                                    "properties":{
                                        "creditLimit":{
                                            "type":"integer",
                                            "format":"double",
                                            "description":"The credit limit of balance group."
                                        },
                                        "unit":{
                                            "type":"string",
                                            "description":"The unit of credit limit."
                                        },
                                        "creditFloor":{
                                            "type":"integer",
                                            "format":"double",
                                            "description":"The credit floor."
                                        },
                                        "dynamicCreditFloor":{
                                            "type":"boolean",
                                            "description":"The Boolean value for dynamic credit floor."
                                        }
                                    },
                                    "required":[
                                        "creditLimit",
                                        "unit"
                                    ]
                                }
                            },
                            "id":{
                                "type":"string",
                                "description":"The identification of the balance group."
                            },
                            "name":{
                                "type":"string",
                                "description":"The name of the balance group."
                            },
                            "isDefault":{
                                "type":"boolean",
                                "description":"The Boolean value for the default balance group."
                            },
                            "tempLimit":{
                                "type":"array",
                                "items":{
                                    "properties":{
                                        "creditLimit":{
                                            "type":"integer",
                                            "format":"double",
                                            "description":"The credit limit."
                                        },
                                        "unit":{
                                            "type":"string",
                                            "description":"The credit limit's unit."
                                        },
                                        "validFrom":{
                                            "type":"string",
                                            "format":"date-time",
                                            "example":"1985-04-12T23:20:50.52Z",
                                            "description":"The valid start date."
                                        },
                                        "validFromDuration":{
                                            "type":"object",
                                            "properties":{
                                                "unit":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "example":"1985-04-12T23:20:50.52Z",
                                                    "description":"The valid start date unit."
                                                },
                                                "offset":{
                                                    "type":"integer",
                                                    "format":"double",
                                                    "description":"The valid start date offset."
                                                }
                                            }
                                        },
                                        "validTo":{
                                            "type":"string",
                                            "format":"date-time",
                                            "example":"1985-04-12T23:20:50.52Z",
                                            "description":"The valid end date."
                                        },
                                        "validToDuration":{
                                            "type":"object",
                                            "properties":{
                                                "unit":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "example":"1985-04-12T23:20:50.52Z",
                                                    "description":"The valid end date unit."
                                                },
                                                "offset":{
                                                    "type":"integer",
                                                    "format":"double",
                                                    "description":"The valid end date offset."
                                                }
                                            }
                                        },
                                        "recId":{
                                            "type":"string",
                                            "description":"The rec ID."
                                        }
                                    },
                                    "required":[
                                        "creditLimit",
                                        "unit"
                                    ]
                                }
                            },
                            "services":{
                                "type":"array",
                                "items":{
                                    "properties":{
                                        "id":{
                                            "type":"string",
                                            "description":"The service id associated with the balance group"
                                        }
                                    }
                                }
                            },
                            "rolledUpCreditLimit":{
                                "type":"integer",
                                "format":"double",
                                "description":"The credit threshold."
                            },
                            "consumptionRule":{
                                "type":"string",
                                "description":"The consumption rule."
                            }
                        }
                    }
                }
            }
        }
    ]
}

• Array of: ContactOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactOracle"
    },
    "description":"The list of people who could be contacted regarding the account, such as the accountant who authorizes payments."
}

• Array of: RelatedPartyOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyOracle"
    },
    "description":"The list of parties that have some relationship with the account, such as the customer to whom the account belongs."
}

• Array of: BillStructureOracle

{
    "type":"array",
    "description":"Array of Bill Structures",
    "items":{
        "$ref":"#/components/schemas/BillStructureOracle"
    }
}

• Array of: TaxExemptionCertificateOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxExemptionCertificateOracle"
    },
    "description":"The list of tax exemptions that can be applied when calculating charges levied to the account."
}

• allOf AccountRelationship
• object AccountRelationshipOracle-allOf[1]
  The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AccountRelationship"
        },
        {
            "type":"object",
            "description":"The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.",
            "properties":{
                "billStructure":{
                    "type":"object",
                    "description":"The bill structure object.",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"The bill structure id of child account."
                        }
                    },
                    "required":[
                        "id"
                    ]
                },
                "relationshipType":{
                    "type":"string",
                    "enum":[
                        "AR",
                        "Parent"
                    ],
                    "description":"The type of relationship&colon; <b>AR</b> or <b>Parent</b>."
                },
                "account":{
                    "type":"object",
                    "description":"The account reference. An account may be a party account or a financial account.",
                    "properties":{
                        "billStructure":{
                            "type":"object",
                            "description":"The bill structure object of the account.",
                            "properties":{
                                "id":{
                                    "type":"string",
                                    "description":"The bill structure ID of the parent account."
                                },
                                "name":{
                                    "type":"string",
                                    "description":"The bill structure name of parent account."
                                }
                            },
                            "required":[
                                "id"
                            ]
                        }
                    },
                    "required":[
                        "account"
                    ]
                }
            }
        }
    ]
}

• account: object account
  The account reference. An account may be a party account or a financial account.
• billStructure: object billStructure
  The bill structure object.
• relationshipType: string
  Allowed Values: [ "AR", "Parent" ]

  The type of relationship: AR or Parent.

{
    "type":"object",
    "description":"The significant connection between accounts. For instance, an aggregating account for a list of shop branches each having its own billing account.",
    "properties":{
        "billStructure":{
            "type":"object",
            "description":"The bill structure object.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The bill structure id of child account."
                }
            },
            "required":[
                "id"
            ]
        },
        "relationshipType":{
            "type":"string",
            "enum":[
                "AR",
                "Parent"
            ],
            "description":"The type of relationship&colon; <b>AR</b> or <b>Parent</b>."
        },
        "account":{
            "type":"object",
            "description":"The account reference. An account may be a party account or a financial account.",
            "properties":{
                "billStructure":{
                    "type":"object",
                    "description":"The bill structure object of the account.",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"The bill structure ID of the parent account."
                        },
                        "name":{
                            "type":"string",
                            "description":"The bill structure name of parent account."
                        }
                    },
                    "required":[
                        "id"
                    ]
                }
            },
            "required":[
                "account"
            ]
        }
    }
}

• billStructure: object billStructure
  The bill structure object of the account.

{
    "type":"object",
    "description":"The account reference. An account may be a party account or a financial account.",
    "properties":{
        "billStructure":{
            "type":"object",
            "description":"The bill structure object of the account.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The bill structure ID of the parent account."
                },
                "name":{
                    "type":"string",
                    "description":"The bill structure name of parent account."
                }
            },
            "required":[
                "id"
            ]
        }
    },
    "required":[
        "account"
    ]
}

• id(required): string
  The bill structure id of child account.

{
    "type":"object",
    "description":"The bill structure object.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The bill structure id of child account."
        }
    },
    "required":[
        "id"
    ]
}

• id(required): string
  The bill structure ID of the parent account.
• name: string
  The bill structure name of parent account.

{
    "type":"object",
    "description":"The bill structure object of the account.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The bill structure ID of the parent account."
        },
        "name":{
            "type":"string",
            "description":"The bill structure name of parent account."
        }
    },
    "required":[
        "id"
    ]
}

• acctSuppressed: boolean
  The accepted values are true and false.
• actgType: string
  Allowed Values: [ "open_items", "balance_forward" ]

  The accounting type: open_items or balance_forward.
• balanceGroup: array balanceGroup
• billingSegment: string
  The billing segment of bill structure.
• businessProfileId: string
  The business profile ID.
• cycleSpecification: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } }

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself
• format: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } }

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillFormat entity and not the BillFormatRefOrValue class itself
• id: string
  The bill unit ID.
• name: string
  The bill unit name.
• payType: string
  Allowed Values: [ "invoice", "credit_card", "direct_debit", "subordinate" ]

  The pay type: invoice, credit_card, direct_debit, or subordinate.
• presentationMedia: array presentationMedia

{
    "type":"object",
    "description":"The structure of the bill for party accounts (billing or settlement).",
    "properties":{
        "presentationMedia":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BillPresentationMediaRefOrValue"
            }
        },
        "format":{
            "$ref":"#/components/schemas/BillFormatRefOrValue"
        },
        "cycleSpecification":{
            "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValueOracle"
        },
        "id":{
            "type":"string",
            "description":"The bill unit ID."
        },
        "businessProfileId":{
            "type":"string",
            "description":"The business profile ID."
        },
        "actgType":{
            "type":"string",
            "enum":[
                "open_items",
                "balance_forward"
            ],
            "description":"The accounting type&colon; <b>open_items</b> or <b>balance_forward</b>."
        },
        "payType":{
            "type":"string",
            "enum":[
                "invoice",
                "credit_card",
                "direct_debit",
                "subordinate"
            ],
            "description":"The pay type&colon; <b>invoice</b>, <b>credit_card</b>, <b>direct_debit</b>, or <b>subordinate</b>."
        },
        "billingSegment":{
            "type":"string",
            "description":"The billing segment of bill structure."
        },
        "acctSuppressed":{
            "type":"boolean",
            "description":"The accepted values are true and false."
        },
        "name":{
            "type":"string",
            "description":"The bill unit name."
        },
        "balanceGroup":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "limit":{
                        "type":"array",
                        "items":{
                            "properties":{
                                "creditLimit":{
                                    "type":"integer",
                                    "format":"double",
                                    "description":"The credit limit of balance group."
                                },
                                "unit":{
                                    "type":"string",
                                    "description":"The unit of credit limit."
                                },
                                "creditFloor":{
                                    "type":"integer",
                                    "format":"double",
                                    "description":"The credit floor."
                                },
                                "dynamicCreditFloor":{
                                    "type":"boolean",
                                    "description":"The Boolean value for dynamic credit floor."
                                }
                            },
                            "required":[
                                "creditLimit",
                                "unit"
                            ]
                        }
                    },
                    "id":{
                        "type":"string",
                        "description":"The identification of the balance group."
                    },
                    "name":{
                        "type":"string",
                        "description":"The name of the balance group."
                    },
                    "isDefault":{
                        "type":"boolean",
                        "description":"The Boolean value for the default balance group."
                    },
                    "tempLimit":{
                        "type":"array",
                        "items":{
                            "properties":{
                                "creditLimit":{
                                    "type":"integer",
                                    "format":"double",
                                    "description":"The credit limit."
                                },
                                "unit":{
                                    "type":"string",
                                    "description":"The credit limit's unit."
                                },
                                "validFrom":{
                                    "type":"string",
                                    "format":"date-time",
                                    "example":"1985-04-12T23:20:50.52Z",
                                    "description":"The valid start date."
                                },
                                "validFromDuration":{
                                    "type":"object",
                                    "properties":{
                                        "unit":{
                                            "type":"string",
                                            "format":"date-time",
                                            "example":"1985-04-12T23:20:50.52Z",
                                            "description":"The valid start date unit."
                                        },
                                        "offset":{
                                            "type":"integer",
                                            "format":"double",
                                            "description":"The valid start date offset."
                                        }
                                    }
                                },
                                "validTo":{
                                    "type":"string",
                                    "format":"date-time",
                                    "example":"1985-04-12T23:20:50.52Z",
                                    "description":"The valid end date."
                                },
                                "validToDuration":{
                                    "type":"object",
                                    "properties":{
                                        "unit":{
                                            "type":"string",
                                            "format":"date-time",
                                            "example":"1985-04-12T23:20:50.52Z",
                                            "description":"The valid end date unit."
                                        },
                                        "offset":{
                                            "type":"integer",
                                            "format":"double",
                                            "description":"The valid end date offset."
                                        }
                                    }
                                },
                                "recId":{
                                    "type":"string",
                                    "description":"The rec ID."
                                }
                            },
                            "required":[
                                "creditLimit",
                                "unit"
                            ]
                        }
                    },
                    "services":{
                        "type":"array",
                        "items":{
                            "properties":{
                                "id":{
                                    "type":"string",
                                    "description":"The service id associated with the balance group"
                                }
                            }
                        }
                    },
                    "rolledUpCreditLimit":{
                        "type":"integer",
                        "format":"double",
                        "description":"The credit threshold."
                    },
                    "consumptionRule":{
                        "type":"string",
                        "description":"The consumption rule."
                    }
                }
            }
        }
    }
}

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "limit":{
                "type":"array",
                "items":{
                    "properties":{
                        "creditLimit":{
                            "type":"integer",
                            "format":"double",
                            "description":"The credit limit of balance group."
                        },
                        "unit":{
                            "type":"string",
                            "description":"The unit of credit limit."
                        },
                        "creditFloor":{
                            "type":"integer",
                            "format":"double",
                            "description":"The credit floor."
                        },
                        "dynamicCreditFloor":{
                            "type":"boolean",
                            "description":"The Boolean value for dynamic credit floor."
                        }
                    },
                    "required":[
                        "creditLimit",
                        "unit"
                    ]
                }
            },
            "id":{
                "type":"string",
                "description":"The identification of the balance group."
            },
            "name":{
                "type":"string",
                "description":"The name of the balance group."
            },
            "isDefault":{
                "type":"boolean",
                "description":"The Boolean value for the default balance group."
            },
            "tempLimit":{
                "type":"array",
                "items":{
                    "properties":{
                        "creditLimit":{
                            "type":"integer",
                            "format":"double",
                            "description":"The credit limit."
                        },
                        "unit":{
                            "type":"string",
                            "description":"The credit limit's unit."
                        },
                        "validFrom":{
                            "type":"string",
                            "format":"date-time",
                            "example":"1985-04-12T23:20:50.52Z",
                            "description":"The valid start date."
                        },
                        "validFromDuration":{
                            "type":"object",
                            "properties":{
                                "unit":{
                                    "type":"string",
                                    "format":"date-time",
                                    "example":"1985-04-12T23:20:50.52Z",
                                    "description":"The valid start date unit."
                                },
                                "offset":{
                                    "type":"integer",
                                    "format":"double",
                                    "description":"The valid start date offset."
                                }
                            }
                        },
                        "validTo":{
                            "type":"string",
                            "format":"date-time",
                            "example":"1985-04-12T23:20:50.52Z",
                            "description":"The valid end date."
                        },
                        "validToDuration":{
                            "type":"object",
                            "properties":{
                                "unit":{
                                    "type":"string",
                                    "format":"date-time",
                                    "example":"1985-04-12T23:20:50.52Z",
                                    "description":"The valid end date unit."
                                },
                                "offset":{
                                    "type":"integer",
                                    "format":"double",
                                    "description":"The valid end date offset."
                                }
                            }
                        },
                        "recId":{
                            "type":"string",
                            "description":"The rec ID."
                        }
                    },
                    "required":[
                        "creditLimit",
                        "unit"
                    ]
                }
            },
            "services":{
                "type":"array",
                "items":{
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"The service id associated with the balance group"
                        }
                    }
                }
            },
            "rolledUpCreditLimit":{
                "type":"integer",
                "format":"double",
                "description":"The credit threshold."
            },
            "consumptionRule":{
                "type":"string",
                "description":"The consumption rule."
            }
        }
    }
}

Discriminator Values

• BillingCycleSpecification
• BillingCycleSpecificationRef

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification",
            "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef"
        }
    }
}

• BillingCycleSpecificationOracle
• object BillingCycleSpecificationRef
  BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.

{
    "type":"object",
    "description":"The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillingCycleSpecification entity and not the BillingCycleSpecificationRefOrValue class itself",
    "oneOf":[
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/BillingCycleSpecificationRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification",
            "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef"
        }
    }
}

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

  The polymorphic attributes @type, @schemaLocation & @referredType are related to the BillPresentationMedia entity and not the BillPresentationMediaRefOrValue class itself

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

• consumptionRule: string
  The consumption rule.
• id: string
  The identification of the balance group.
• isDefault: boolean
  The Boolean value for the default balance group.
• limit: array limit
• name: string
  The name of the balance group.
• rolledUpCreditLimit: integer (double)
  The credit threshold.
• services: array services
• tempLimit: array tempLimit

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"array",
            "items":{
                "properties":{
                    "creditLimit":{
                        "type":"integer",
                        "format":"double",
                        "description":"The credit limit of balance group."
                    },
                    "unit":{
                        "type":"string",
                        "description":"The unit of credit limit."
                    },
                    "creditFloor":{
                        "type":"integer",
                        "format":"double",
                        "description":"The credit floor."
                    },
                    "dynamicCreditFloor":{
                        "type":"boolean",
                        "description":"The Boolean value for dynamic credit floor."
                    }
                },
                "required":[
                    "creditLimit",
                    "unit"
                ]
            }
        },
        "id":{
            "type":"string",
            "description":"The identification of the balance group."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance group."
        },
        "isDefault":{
            "type":"boolean",
            "description":"The Boolean value for the default balance group."
        },
        "tempLimit":{
            "type":"array",
            "items":{
                "properties":{
                    "creditLimit":{
                        "type":"integer",
                        "format":"double",
                        "description":"The credit limit."
                    },
                    "unit":{
                        "type":"string",
                        "description":"The credit limit's unit."
                    },
                    "validFrom":{
                        "type":"string",
                        "format":"date-time",
                        "example":"1985-04-12T23:20:50.52Z",
                        "description":"The valid start date."
                    },
                    "validFromDuration":{
                        "type":"object",
                        "properties":{
                            "unit":{
                                "type":"string",
                                "format":"date-time",
                                "example":"1985-04-12T23:20:50.52Z",
                                "description":"The valid start date unit."
                            },
                            "offset":{
                                "type":"integer",
                                "format":"double",
                                "description":"The valid start date offset."
                            }
                        }
                    },
                    "validTo":{
                        "type":"string",
                        "format":"date-time",
                        "example":"1985-04-12T23:20:50.52Z",
                        "description":"The valid end date."
                    },
                    "validToDuration":{
                        "type":"object",
                        "properties":{
                            "unit":{
                                "type":"string",
                                "format":"date-time",
                                "example":"1985-04-12T23:20:50.52Z",
                                "description":"The valid end date unit."
                            },
                            "offset":{
                                "type":"integer",
                                "format":"double",
                                "description":"The valid end date offset."
                            }
                        }
                    },
                    "recId":{
                        "type":"string",
                        "description":"The rec ID."
                    }
                },
                "required":[
                    "creditLimit",
                    "unit"
                ]
            }
        },
        "services":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"The service id associated with the balance group"
                    }
                }
            }
        },
        "rolledUpCreditLimit":{
            "type":"integer",
            "format":"double",
            "description":"The credit threshold."
        },
        "consumptionRule":{
            "type":"string",
            "description":"The consumption rule."
        }
    }
}

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "creditLimit":{
                "type":"integer",
                "format":"double",
                "description":"The credit limit of balance group."
            },
            "unit":{
                "type":"string",
                "description":"The unit of credit limit."
            },
            "creditFloor":{
                "type":"integer",
                "format":"double",
                "description":"The credit floor."
            },
            "dynamicCreditFloor":{
                "type":"boolean",
                "description":"The Boolean value for dynamic credit floor."
            }
        },
        "required":[
            "creditLimit",
            "unit"
        ]
    }
}

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"string",
                "description":"The service id associated with the balance group"
            }
        }
    }
}

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "creditLimit":{
                "type":"integer",
                "format":"double",
                "description":"The credit limit."
            },
            "unit":{
                "type":"string",
                "description":"The credit limit's unit."
            },
            "validFrom":{
                "type":"string",
                "format":"date-time",
                "example":"1985-04-12T23:20:50.52Z",
                "description":"The valid start date."
            },
            "validFromDuration":{
                "type":"object",
                "properties":{
                    "unit":{
                        "type":"string",
                        "format":"date-time",
                        "example":"1985-04-12T23:20:50.52Z",
                        "description":"The valid start date unit."
                    },
                    "offset":{
                        "type":"integer",
                        "format":"double",
                        "description":"The valid start date offset."
                    }
                }
            },
            "validTo":{
                "type":"string",
                "format":"date-time",
                "example":"1985-04-12T23:20:50.52Z",
                "description":"The valid end date."
            },
            "validToDuration":{
                "type":"object",
                "properties":{
                    "unit":{
                        "type":"string",
                        "format":"date-time",
                        "example":"1985-04-12T23:20:50.52Z",
                        "description":"The valid end date unit."
                    },
                    "offset":{
                        "type":"integer",
                        "format":"double",
                        "description":"The valid end date offset."
                    }
                }
            },
            "recId":{
                "type":"string",
                "description":"The rec ID."
            }
        },
        "required":[
            "creditLimit",
            "unit"
        ]
    }
}

• creditFloor: integer (double)
  The credit floor.
• creditLimit(required): integer (double)
  The credit limit of balance group.
• dynamicCreditFloor: boolean
  The Boolean value for dynamic credit floor.
• unit(required): string
  The unit of credit limit.

{
    "properties":{
        "creditLimit":{
            "type":"integer",
            "format":"double",
            "description":"The credit limit of balance group."
        },
        "unit":{
            "type":"string",
            "description":"The unit of credit limit."
        },
        "creditFloor":{
            "type":"integer",
            "format":"double",
            "description":"The credit floor."
        },
        "dynamicCreditFloor":{
            "type":"boolean",
            "description":"The Boolean value for dynamic credit floor."
        }
    },
    "required":[
        "creditLimit",
        "unit"
    ]
}

• id: string
  The service id associated with the balance group

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The service id associated with the balance group"
        }
    }
}

• creditLimit(required): integer (double)
  The credit limit.
• recId: string
  The rec ID.
• unit(required): string
  The credit limit's unit.
• validFrom: string (date-time)
  The valid start date.

  Example: 1985-04-12T23:20:50.52Z
• validFromDuration: object validFromDuration
• validTo: string (date-time)
  The valid end date.

  Example: 1985-04-12T23:20:50.52Z
• validToDuration: object validToDuration

{
    "properties":{
        "creditLimit":{
            "type":"integer",
            "format":"double",
            "description":"The credit limit."
        },
        "unit":{
            "type":"string",
            "description":"The credit limit's unit."
        },
        "validFrom":{
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z",
            "description":"The valid start date."
        },
        "validFromDuration":{
            "type":"object",
            "properties":{
                "unit":{
                    "type":"string",
                    "format":"date-time",
                    "example":"1985-04-12T23:20:50.52Z",
                    "description":"The valid start date unit."
                },
                "offset":{
                    "type":"integer",
                    "format":"double",
                    "description":"The valid start date offset."
                }
            }
        },
        "validTo":{
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z",
            "description":"The valid end date."
        },
        "validToDuration":{
            "type":"object",
            "properties":{
                "unit":{
                    "type":"string",
                    "format":"date-time",
                    "example":"1985-04-12T23:20:50.52Z",
                    "description":"The valid end date unit."
                },
                "offset":{
                    "type":"integer",
                    "format":"double",
                    "description":"The valid end date offset."
                }
            }
        },
        "recId":{
            "type":"string",
            "description":"The rec ID."
        }
    },
    "required":[
        "creditLimit",
        "unit"
    ]
}

• offset: integer (double)
  The valid start date offset.
• unit: string (date-time)
  The valid start date unit.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "properties":{
        "unit":{
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z",
            "description":"The valid start date unit."
        },
        "offset":{
            "type":"integer",
            "format":"double",
            "description":"The valid start date offset."
        }
    }
}

• offset: integer (double)
  The valid end date offset.
• unit: string (date-time)
  The valid end date unit.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "properties":{
        "unit":{
            "type":"string",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z",
            "description":"The valid end date unit."
        },
        "offset":{
            "type":"integer",
            "format":"double",
            "description":"The valid end date offset."
        }
    }
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.
• object BillingCycleSpecificationOracle-allOf[1]
  A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"A short descriptive name"
                },
                "billingDateShift":{
                    "type":"integer",
                    "description":"An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period."
                },
                "description":{
                    "type":"string",
                    "description":"An explanation regarding this billing cycle specification"
                },
                "frequency":{
                    "type":"string",
                    "enum":[
                        "monthly",
                        "bi-monthly",
                        "quarterly",
                        "semiyearly",
                        "yearly"
                    ],
                    "description":"The frequency of the billing cycle&colon; <b>monthly</b>, <b>bi-monthly</b>, <b>quarterly</b>, <b>semiyearly</b>, or <b>yearly</b>."
                },
                "paymentDueDateOffset":{
                    "type":"integer",
                    "description":"An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod."
                }
            }
        }
    ]
}

• billingDateShift: integer
  An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
• description: string
  An explanation regarding this billing cycle specification
• frequency: string
  Allowed Values: [ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ]

  The frequency of the billing cycle: monthly, bi-monthly, quarterly, semiyearly, or yearly.
• name: string
  A short descriptive name
• paymentDueDateOffset: integer
  An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.

{
    "type":"object",
    "description":"A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.",
    "properties":{
        "name":{
            "type":"string",
            "description":"A short descriptive name"
        },
        "billingDateShift":{
            "type":"integer",
            "description":"An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period."
        },
        "description":{
            "type":"string",
            "description":"An explanation regarding this billing cycle specification"
        },
        "frequency":{
            "type":"string",
            "enum":[
                "monthly",
                "bi-monthly",
                "quarterly",
                "semiyearly",
                "yearly"
            ],
            "description":"The frequency of the billing cycle&colon; <b>monthly</b>, <b>bi-monthly</b>, <b>quarterly</b>, <b>semiyearly</b>, or <b>yearly</b>."
        },
        "paymentDueDateOffset":{
            "type":"integer",
            "description":"An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod."
        }
    }
}

• object ContactOracle-allOf[0]
  A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.

{
    "allOf":[
        {
            "type":"object",
            "description":"A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.\n",
            "properties":{
                "salutation":{
                    "type":"string",
                    "description":"Salutation for name"
                },
                "contactName":{
                    "type":"string",
                    "description":"Name of the contact"
                },
                "contactType":{
                    "type":"string",
                    "description":"Type of the contact"
                },
                "contactMedium":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContactMediumOracle"
                    }
                }
            }
        }
    ]
}

• contactMedium: array contactMedium
• contactName: string
  Name of the contact
• contactType: string
  Type of the contact
• salutation: string
  Salutation for name

{
    "type":"object",
    "description":"A list of individuals or organizations used as contact points for a given account, each accessed via some contact medium.\n",
    "properties":{
        "salutation":{
            "type":"string",
            "description":"Salutation for name"
        },
        "contactName":{
            "type":"string",
            "description":"Name of the contact"
        },
        "contactType":{
            "type":"string",
            "description":"Type of the contact"
        },
        "contactMedium":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactMediumOracle"
            }
        }
    }
}

• Array of: ContactMediumOracle

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

• object ContactMediumOracle-allOf[0]
  The contact medium that could be used to contact the party.

{
    "allOf":[
        {
            "type":"object",
            "description":"The contact medium that could be used to contact the party.",
            "properties":{
                "mediumType":{
                    "type":"string",
                    "enum":[
                        "PostalAddress",
                        "Phone",
                        "Email",
                        "Fax"
                    ],
                    "description":"The type of contact medium&colon; <b>PostalAddress</b>, <b>Phone</b>, <b>Email</b>, or <b>Fax</b>."
                },
                "company":{
                    "type":"string",
                    "description":"Associated company name."
                },
                "geoCode":{
                    "type":"string",
                    "description":"Geographic code for the address."
                },
                "phoneType":{
                    "type":"string",
                    "enum":[
                        "email",
                        "home",
                        "work",
                        "pager",
                        "portable",
                        "pop",
                        "support"
                    ],
                    "description":"The phone type classification&colon; <b>email</b>, <b>home</b>, <b>work</b>, <b>pager</b>, <b>portable</b>, <b>pop</b>, or <b>support</b>."
                }
            }
        }
    ],
    "required":[
        "mediumType"
    ]
}

• company: string
  Associated company name.
• geoCode: string
  Geographic code for the address.
• mediumType: string
  Allowed Values: [ "PostalAddress", "Phone", "Email", "Fax" ]

  The type of contact medium: PostalAddress, Phone, Email, or Fax.
• phoneType: string
  Allowed Values: [ "email", "home", "work", "pager", "portable", "pop", "support" ]

  The phone type classification: email, home, work, pager, portable, pop, or support.

{
    "type":"object",
    "description":"The contact medium that could be used to contact the party.",
    "properties":{
        "mediumType":{
            "type":"string",
            "enum":[
                "PostalAddress",
                "Phone",
                "Email",
                "Fax"
            ],
            "description":"The type of contact medium&colon; <b>PostalAddress</b>, <b>Phone</b>, <b>Email</b>, or <b>Fax</b>."
        },
        "company":{
            "type":"string",
            "description":"Associated company name."
        },
        "geoCode":{
            "type":"string",
            "description":"Geographic code for the address."
        },
        "phoneType":{
            "type":"string",
            "enum":[
                "email",
                "home",
                "work",
                "pager",
                "portable",
                "pop",
                "support"
            ],
            "description":"The phone type classification&colon; <b>email</b>, <b>home</b>, <b>work</b>, <b>pager</b>, <b>portable</b>, <b>pop</b>, or <b>support</b>."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object RelatedPartyOracle-allOf[1]
  The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity",
            "properties":{
                "role":{
                    "description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer',  'salesAgent', 'user'",
                    "type":"string"
                },
                "partyOrPartyRole":{
                    "$ref":"#/components/schemas/PartyRefOrPartyRoleRef"
                }
            },
            "required":[
                "role"
            ]
        }
    ]
}

• partyOrPartyRole: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } }

  The reference allows either a party or a party role to be specified.
• role(required): string
  The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'

{
    "type":"object",
    "description":"The relatedParty reference. A related party defines party or party role or its reference, linked to a specific entity",
    "properties":{
        "role":{
            "description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer',  'salesAgent', 'user'",
            "type":"string"
        },
        "partyOrPartyRole":{
            "$ref":"#/components/schemas/PartyRefOrPartyRoleRef"
        }
    },
    "required":[
        "role"
    ]
}

• object allOf TaxExemptionCertificateOracle-allOf[0]
  A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.

{
    "allOf":[
        {
            "type":"object",
            "description":"A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Entity"
                }
            ],
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Identifier of the tax exemption within list of the exemptions"
                },
                "validFor":{
                    "$ref":"#/components/schemas/TimePeriod"
                },
                "certificateNumber":{
                    "type":"string",
                    "description":"The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction."
                },
                "issuingJurisdiction":{
                    "type":"string",
                    "description":"Name of the jurisdiction that issued the exemption",
                    "example":"USA"
                },
                "reason":{
                    "type":"string",
                    "description":"Reason for the tax exemption"
                },
                "taxDefinition":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TaxDefinitionOracle"
                    },
                    "description":"A list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

• certificateNumber: string
  The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction.
• id(required): string
  Identifier of the tax exemption within list of the exemptions
• issuingJurisdiction: string
  Name of the jurisdiction that issued the exemption

  Example: USA
• reason: string
  Reason for the tax exemption
• taxDefinition: array taxDefinition
  A list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%).
• validFor: object TimePeriod
  The period of time, as a deadline (endDateTime only), a startDateTime only, or both.

{
    "type":"object",
    "description":"A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the tax exemption within list of the exemptions"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "certificateNumber":{
            "type":"string",
            "description":"The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction."
        },
        "issuingJurisdiction":{
            "type":"string",
            "description":"Name of the jurisdiction that issued the exemption",
            "example":"USA"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the tax exemption"
        },
        "taxDefinition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxDefinitionOracle"
            },
            "description":"A list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
        }
    },
    "required":[
        "id"
    ]
}

• object allOf Entity
  The Base entity schema for use in TMForum Open-APIs Property.

{
    "type":"object",
    "description":"A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the tax exemption within list of the exemptions"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "certificateNumber":{
            "type":"string",
            "description":"The identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction."
        },
        "issuingJurisdiction":{
            "type":"string",
            "description":"Name of the jurisdiction that issued the exemption",
            "example":"USA"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the tax exemption"
        },
        "taxDefinition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxDefinitionOracle"
            },
            "description":"A list of taxes that are covered by the exemption, such as City Tax or State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)."
        }
    },
    "required":[
        "id"
    ]
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

• object Extensible
  The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}