TM Forum · Schema

Party

Party schema from TM Forum API

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tmf637-product-inventory-party-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf637-product-inventory-party-schema.json",
  "title": "Party",
  "description": "Party schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity"
    },
    {
      "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"
          },
          "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"
          },
          "description": "List of additional characteristics that a Party can take on."
        },
        "taxExemptionCertificate": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TaxExemptionCertificate"
          },
          "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"
          },
          "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"
          },
          "description": "List of parties and/or party roles related to this party"
        },
        "contactMedium": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ContactMedium"
          },
          "description": "List of means for contacting the party, e.g. mobile phone, email address"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "Party": "#/components/schemas/Party",
      "Organization": "#/components/schemas/Organization",
      "Individual": "#/components/schemas/Individual"
    }
  }
}