d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-json-response-schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-json-response-schema-schema.json",
  "title": "d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-json-response-schema",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-billing-api-openapi.yml#/components/schemas/d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-json-response-schema",
  "type": "object",
  "properties": {
    "Count": {
      "type": "number",
      "format": "integer"
    },
    "PagedList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-data-schema"
      }
    }
  },
  "$defs": {
    "d3723b0b-c5b9-4306-854c-8d1e7bc59ed3-data-schema": {
      "type": "object",
      "properties": {
        "REPORTING_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Invoice Update Date is the date on which the invoice was last changed."
        },
        "BILLING_PERIOD": {
          "type": "string",
          "description": "Represents the specific date or timestamp associated with the billing period used for invoice calculation."
        },
        "SAFE_KEEPING_ACCOUNT": {
          "type": "string",
          "description": "Account ID is an identifier for both a Cash Account and/or a Safekeeping Account that is unique within a branch."
        },
        "INVOICE_NUMBER": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Number is the unique reference number of the invoice."
        },
        "INVOICE_SCHEDULE_ID": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Schedule Identifier is a unique reference for the schedule under which each invoice is created."
        },
        "REVISION_NUMBER": {
          "type": "integer",
          "format": "int32",
          "description": "Revision Number indicates how many times the invoice has been revised."
        },
        "CORP_ACT_ID": {
          "type": "string",
          "description": "Event Reference is the reference associated to the corporate action event."
        },
        "CORPORATE_ACTION_TYPE": {
          "type": "string",
          "description": "Corporate Action Type is a 3 digit code indicating the type of corporate action."
        },
        "DESCRIPTION": {
          "type": "string",
          "description": "Charge Description is a description of the charge reason."
        },
        "CENTER": {
          "type": "string",
          "description": "Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding."
        },
        "CENTER_NAME": {
          "type": "string",
          "description": "Place Of Settlement is the settlement location of the holding."
        },
        "RELEASE_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Payment Release Date is the date on which payment of the corporate action was released."
        },
        "CUSTOMER": {
          "type": "string",
          "description": "Client ID is an identifier for the client as set up in the core billing system."
        },
        "SWIFT_CODE": {
          "type": "string",
          "description": "Event Code (SWIFT) is the corporate type code per SWIFT standards."
        },
        "BENCHMARK_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Ex Date is the trading cut off date after which position changes will no longer alter the eligibility to the corporate action."
        },
        "PAY_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Pay Date is the pay date of the dividend payment."
        },
        "VALUE_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Value Date is the date on which the cash posting is expected to be valued."
        },
        "QTY_PAID": {
          "type": "string",
          "description": "Quantity Paid"
        },
        "NET_PYMT_OF_DIV": {
          "type": "string",
          "description": "Net Payment is the amount of the associated cash posting."
        },
        "ASSOC_TRADE_REF": {
          "type": "string",
          "description": "Cash Reference is the Reference of the cash posting associated with the event."
        },
        "DIV_CURRENCY": {
          "type": "string",
          "description": "Dividend Currency is the ISO 4217 currency code of the currency in which the dividend is paid."
        },
        "FEE": {
          "type": "number",
          "format": "double",
          "description": "Fee is the charge in the Fee Schedule Currency."
        },
        "FEE_CCY": {
          "type": "string",
          "description": "Total Fee (Fee Schedule Currency) is the total charge for the billable activity in the Fee Schedule Currency, It is the ISO 4217 currency code corresponding to the currency in which the rate card is published."
        },
        "TOTAL_FEE": {
          "type": "number",
          "format": "double",
          "description": "Total Fee"
        },
        "BOOKING_OFFICE_ID": {
          "type": "string",
          "description": "Branch Code is the identifier of the branch for the safekeeping account."
        },
        "CLARITY_BRANCH_NAME": {
          "type": "string",
          "description": "Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account."
        },
        "MARKET": {
          "type": "string",
          "description": "Market is the name of the market or International Central Securities Depositories in which the billable activity has occurred."
        },
        "REGION": {
          "type": "string",
          "description": "Region is the name of the geographical region (if appropriate) in which the billable activity has occurred."
        },
        "FUND_MANAGER": {
          "type": "string",
          "description": "A fund manager is a person or company who manages a portfolio of investments for a fund's clients, Fund Manager field from Client Profile Table."
        },
        "LEAD_FUND_MANAGER": {
          "type": "string",
          "description": "A lead fund manager is a person or company who manages a portfolio of investments for a fund's clients."
        },
        "MARKETING_GFCID_L4_NAME": {
          "type": "string",
          "description": "A Global Finance Customer Identifier (GFCID) is a 10-digit identifier assigned to represent legal entities as well as branches and sub accounts within ICG and other businesses This is the L4 GFCID for the client record. Where the L4 GFCID is equal to GFCID the GFCID the record identifies an L4 GFCID. This represents the Sub-Account level as recorded in the STaRs (Service Tracking and Reporting System) for the specified source region."
        },
        "ACCT_NME": {
          "type": "string",
          "description": "Account Name is the name that is assigned to the Cash Account and/or the Safekeeping Account."
        },
        "BR_ID": {
          "type": "string",
          "description": "Branch Code is the identifier of the branch for the account."
        },
        "ALTV_CUR_CD": {
          "type": "string",
          "description": "Account Base Currency Code is the ISO 4217 Currency Code for the account."
        },
        "ACCT_BASE_NBR": {
          "type": "string",
          "description": "Account Base Number is an internal client identifier that is associated to a Safekeeping or Cash Account."
        },
        "ACCT_BUS_TYP_CD": {
          "type": "string",
          "description": "A code to indicate the type of account - Cash, Safekeeping or E-Report."
        },
        "SID_SEDOL": {
          "type": "string",
          "description": "SEDOL (Stock Exchange Daily Official List) is a unique identification code, consisting of seven alphanumeric characters."
        },
        "SID_CUSIP": {
          "type": "string",
          "description": "CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code."
        },
        "SID_TICKER_SYMB": {
          "type": "string",
          "description": "Ticker is the symbol used on the exchange to identify the security."
        },
        "SID_ISIN": {
          "type": "string",
          "description": "ISIN (International Securities Identification Number) is a 12-character alpha-numerical code."
        },
        "SEC_SHRT_NME": {
          "type": "string",
          "description": "Issue Name is the Security Name of the security instrument."
        },
        "EXCH_MNEM": {
          "type": "string",
          "description": "The internal code for the exchange/market."
        },
        "SEC_SECURITY_CD": {
          "type": "string",
          "description": "Internal Security Code is the identifier of the Internal Security Identifier."
        },
        "PFD_ID_CTXT_CD": {
          "type": "string",
          "description": "Security ID Type indicates the type of identifier of the corresponding Security ID field. Values may include: CUSIP, ISIN, SEDOL, LOCAL."
        },
        "PFD_ISS_ID": {
          "type": "string",
          "description": "Security ID is the most commonly used identifier for the security in a given market."
        },
        "DNOMD_CUR_CD": {
          "type": "string",
          "description": "The currency in which this security is denominated in the local market."
        },
        "BKING_CUR_CD": {
          "type": "string",
          "description": "The code of the native or local currency in which this cash flow is scheduled to actually occur."
        },
        "DLAY_DAYS": {
          "type": "string",
          "description": "Delay Days"
        },
        "PMT_FREQY_DESC": {
          "type": "string",
          "description": "Payment Frequency Description indicates how often interest is paid on the security.  Values may include: Annual (00001),  Sem-Annual (00002), One Payment Per Year (00035), etc."
        },
        "PMT_FREQY": {
          "type": "string",
          "description": "Payment Frequency indicates how often interest is paid on the security.  Values may include: 00001 (Annual), 00002 (Sem-Annual), 00035 (One Payment Per Year), etc. "
        },
        "ISS_CATG_CD": {
          "type": "string",
          "description": "Issue Category Code is a specific category for the security.  Values may include: CSTK (Common Stock), DERIV (Derivatives), MBS (Mortgage Backed Securities), etc."
        },
        "ISS_CAT_NME": {
          "type": "string",
          "description": "The classification of the security as ADR,CMO, ETF etc."
        },
        "IOD_TIMESTAMP": {
          "type": "string",
          "format": "date-time",
          "description": "Provides the Timestamp when data is loaded in the Data Lake."
        },
        "ISO_COUNTRY_CODE": {
          "type": "string",
          "description": "ISO country code is the ISO 3166 code corresponding to the country in which the invoice is to be paid."
        },
        "SECURITY_QUOTATION_SOURCE": {
          "type": "string",
          "description": "Security Quotation Source"
        }
      }
    }
  }
}