3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-json-response-schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-json-response-schema-schema.json",
  "title": "3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-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/3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-json-response-schema",
  "type": "object",
  "properties": {
    "Count": {
      "type": "number",
      "format": "integer"
    },
    "PagedList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-data-schema"
      }
    }
  },
  "$defs": {
    "3291fe1b-9d6f-4285-9836-a2c66ac1dbd3-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."
        },
        "BRANCH_ID": {
          "type": "integer",
          "format": "int32",
          "description": "Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO 3166 Country code."
        },
        "BILLING_PERIOD": {
          "type": "string",
          "description": "Represents the specific date or timestamp associated with the billing period used for invoice calculation."
        },
        "INVOICE_SCHEDULE_ID": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Schedule Identifier is a unique reference for the schedule under which each invoice is created."
        },
        "SK_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."
        },
        "CLIENT_ID": {
          "type": "string",
          "description": "Client ID is an identifier for the client as set up in the core billing system."
        },
        "SK_GRP_NAME": {
          "type": "string",
          "description": "Safekeeping Group Name is the name of a group of safekeeping accounts that the client has defined and set up in the core billing system."
        },
        "PROFIT_CENTER": {
          "type": "integer",
          "format": "int32",
          "description": "Profit Centre is an internal field not for client consumption."
        },
        "PROFIT_CENTER_NAME": {
          "type": "string",
          "description": "Profit Centre Name is an internal field not for client consumption."
        },
        "CENTRE_CODE": {
          "type": "string",
          "description": "Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding."
        },
        "NAME": {
          "type": "string",
          "description": "Place Of Settlement is the settlement location of the holding."
        },
        "ASSET_TYPE": {
          "type": "string",
          "description": "Asset Type is a code representing the Asset Type of the security. Values may include EQTY Equity FI Fixed Income etc."
        },
        "CURRENCY": {
          "type": "string",
          "description": "Currency is the ISO 4217 currency code corresponding to the currency in the market. The currency of the balance/bank account, List of possible values: AED: UAE Dirham AFN: Afghani ALL: Lek AMD: Armenian Dram ANG: Netherlands Antillean Guilder AOA: Kwanza ARS: Argentine."
        },
        "MARKET_VALUE": {
          "type": "number",
          "format": "double",
          "description": "Market Value is the market value at the Market Value Date in the Market Currency."
        },
        "AVG_MARKET_VALUE": {
          "type": "number",
          "format": "double",
          "description": "Average Market Value is the average daily market value across the billing period in the Market Currency."
        },
        "AVERAGE_QUANTITY_SHARES": {
          "type": "number",
          "format": "double",
          "description": "Average Quantity is the average daily settled quantity across the billing period."
        },
        "UNITS_OF_SHARE": {
          "type": "number",
          "format": "double",
          "description": "Units of Share"
        },
        "MARKET_VALUE_DATE": {
          "type": "string",
          "description": "Market Value Date is the date on which the Market Value is provided."
        },
        "HOLDINGS": {
          "type": "number",
          "format": "double",
          "description": "Quantity is the settled quantity of the security at the Market Value Date."
        },
        "PRICE": {
          "type": "number",
          "format": "double",
          "description": "Issue Price is the price of the security at the Market Value Date."
        },
        "ISIN": {
          "type": "string",
          "description": "ISIN International Securities Identification Number is a 12 character alpha numerical code governed by ISO 6166 it is a uniform identification of a security at trading and settlement."
        },
        "PRICE_CURRENCY": {
          "type": "string",
          "description": "Issue Price Currency is the ISO 4217 currency code corresponding to the currency in which the Issue Price is published."
        },
        "FEE": {
          "type": "number",
          "format": "double",
          "description": "Fee is the charge in the Fee Schedule Currency."
        },
        "FEE_CURRENCY": {
          "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."
        },
        "REVISION_NUMBER": {
          "type": "integer",
          "format": "int32",
          "description": "Revision Number indicates how many times the invoice has been revised."
        },
        "INVOICE_NUMBER": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Number is the unique reference number of the invoice."
        },
        "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 funds 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 funds 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. If an Alternate Account Name has been specified for an account it will be displayed as the Account Name."
        },
        "BR_ID": {
          "type": "string",
          "description": "Branch Code is the identifier of the branch for the account. For the Cash Account the branch code is a numeric value and for the Safekeeping Account it is the ISO 3166 Country code."
        },
        "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 or A customer ID associated with a group (one or more) of accounts held by that customer."
        },
        "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, that is assigned to all securities trading on the London Stock Exchange."
        },
        "SID_CUSIP": {
          "type": "string",
          "description": "CUSIP (Committee on Uniform Securities Identification Procedures) It is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades."
        },
        "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 that does not contain information characterizing financial instruments but serves for uniform identification of a security at trading and settlement."
        },
        "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. Possible values may include: CUSIP, ISIN, SEDOL, LOCAL, etc."
        },
        "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. Possible 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. Possible 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. Possible 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."
        },
        "POSITION_LOCATION_CODE": {
          "type": "string",
          "description": "Position Location Code"
        },
        "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"
        }
      }
    }
  }
}