TM Forum · JSON Structure

Tmf629 Customer Management Party Credit Profile Structure

PartyCreditProfile schema from TM Forum API

Type: Properties: 0
TelcoTelecommunicationsBSSOSSOpen APIsStandards

PartyCreditProfile is a JSON Structure definition published by TM Forum. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-structure/tmf629-customer-management-party-credit-profile-structure.json",
  "name": "PartyCreditProfile",
  "description": "PartyCreditProfile schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity"
    },
    {
      "type": "object",
      "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.",
      "properties": {
        "creditAgencyName": {
          "type": "string",
          "description": "Name of the credit agency giving the score"
        },
        "creditAgencyType": {
          "type": "string",
          "description": "Type of the credit agency giving the score"
        },
        "ratingReference": {
          "type": "string",
          "description": "Reference corresponding to the credit rating"
        },
        "ratingScore": {
          "type": "int32",
          "description": "A measure of a party's creditworthiness calculated on the basis of a combination of factors such as their income and credit history"
        },
        "validFor": {
          "$ref": "#/components/schemas/TimePeriod"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "PartyCreditProfile": "#/components/schemas/PartyCreditProfile"
    }
  }
}