TM Forum · Schema

Party_FVO

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tm-forum-party-fvo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Party_FVO",
  "title": "Party_FVO",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity_FVO"
    },
    {
      "type": "object",
      "description": "Generic and Abstract Party structure used to define commonalities between sub concepts of Individual and Organization.",
      "properties": {
        "externalReference": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ExternalIdentifier_FVO"
          },
          "description": "List of identifiers of the Party in an external system, for example when party information is imported from a commerce system"
        },
        "partyCharacteristic": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Characteristic_FVO"
          },
          "description": "List of additional characteristics that a Party can take on."
        },
        "taxExemptionCertificate": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxExemptionCertificate_FVO"
          },
          "description": "List of tax exemptions granted to the party. For example, a war veteran might have partial exemption from state tax and a full exemption from federal tax"
        },
        "creditRating": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PartyCreditProfile_FVO"
          },
          "description": "List of credit profiles and scores for the party, typically received from an external credit broker"
        },
        "relatedParty": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/RelatedPartyOrPartyRole_FVO"
          },
          "description": "List of parties and/or party roles related to this party"
        },
        "contactMedium": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ContactMedium_FVO"
          },
          "description": "List of means for contacting the party, e.g. mobile phone, email address"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "Party": "#/components/schemas/Party_FVO",
      "Organization": "#/components/schemas/Organization_FVO",
      "Individual": "#/components/schemas/Individual_FVO"
    }
  }
}