a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-json-response-schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-json-response-schema-schema.json",
  "title": "a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-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/a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-json-response-schema",
  "type": "object",
  "properties": {
    "Count": {
      "type": "number",
      "format": "integer"
    },
    "PagedList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-data-schema"
      }
    }
  },
  "$defs": {
    "a5ae4ee1-c9c8-4b1b-9437-8acdc6ac815c-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."
        },
        "INVOICE_SCHEDULE_ID": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Schedule Identifier is a unique reference for the schedule under which each invoice is created."
        },
        "INVOICE_NUMBER": {
          "type": "integer",
          "format": "int64",
          "description": "Invoice Number is the unique reference number of the invoice."
        },
        "REV_NO": {
          "type": "integer",
          "format": "int32",
          "description": "Revision Number indicates how many times the invoice has been revised."
        },
        "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."
        },
        "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."
        },
        "TXN_TYPE": {
          "type": "string",
          "description": "Transaction Type is a descriptive name for the type of transaction."
        },
        "VAL_TYPE_ID": {
          "type": "string",
          "description": "Valuation Type indicates where the trade is equity vs desk."
        },
        "TXN_REF": {
          "type": "string",
          "description": "Citi Reference is the unique reference number of the trade within Citi systems."
        },
        "TXN_COUNT": {
          "type": "integer",
          "format": "int32",
          "description": "Partial Settlement Count indicates how many separate settlements took place for the transaction if it partially settled. If full settlement occurred this will be 0."
        },
        "BROKER_CODE": {
          "type": "string",
          "description": "Counterparty is the counterparty of the trade."
        },
        "ACTUAL_SETTLEMENT_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Actual Settlement Date is the date when the trade settled in market or date of final settlement of the trade."
        },
        "CONCEPTUAL_SETTLEMENT_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Contractual Settlement Date is the date when the trade was supposed to settle in the market."
        },
        "INSTR_MODE": {
          "type": "string",
          "description": "Instruction Mode is an internal classification for how the transaction was instructed."
        },
        "CURRENCY": {
          "type": "string",
          "description": "Currency is the ISO 4217 currency code corresponding to the currency in the market."
        },
        "CONSIDERATION": {
          "type": "number",
          "format": "double",
          "description": "Settlement Amount is the cash value of the transaction in the Market Currency."
        },
        "CUST_REF": {
          "type": "string",
          "description": "Client Reference is a unique number assigned by the client to the transaction."
        },
        "CLIENT_ID": {
          "type": "string",
          "description": "Client ID is an identifier for the client as set up in the core billing system."
        },
        "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."
        },
        "TOTAL_FEE": {
          "type": "number",
          "format": "double",
          "description": "Total Fee."
        },
        "QUANTITY": {
          "type": "number",
          "format": "double",
          "description": "Quantity provides the number of units of the traded security."
        },
        "BENEFICIARY": {
          "type": "string",
          "description": "Beneficiary is the ultimate beneficiary of the transaction and the recipient of the funds."
        },
        "CLARITY_BRANCH_NAME": {
          "type": "string",
          "description": "Branch Name is the name of the branch for the account."
        },
        "MARKET": {
          "type": "string",
          "description": "Market is the name of the market or International Central Securities Depositories."
        },
        "REGION": {
          "type": "string",
          "description": "Region is the name of the geographical region in which the billable activity has occurred."
        },
        "CENTRE_CODE": {
          "type": "string",
          "description": "Place Of Settlement Code is a 3 digit code corresponding to the settlement location."
        },
        "ACCT_NME": {
          "type": "string",
          "description": "Account Name is the name assigned to the Cash or 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 Citi client identifier associated with accounts."
        },
        "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 is a seven-character identification code for securities trading."
        },
        "SID_CUSIP": {
          "type": "string",
          "description": "CUSIP is a nine-character alphanumeric code identifying securities."
        },
        "SID_TICKER_SYMB": {
          "type": "string",
          "description": "Ticker is the symbol used on the exchange."
        },
        "SID_ISIN": {
          "type": "string",
          "description": "ISIN is a 12-character alphanumeric code for security identification."
        },
        "SEC_SHRT_NME": {
          "type": "string",
          "description": "Issue Name is the Security Name."
        },
        "EXCH_MNEM": {
          "type": "string",
          "description": "Internal code for the exchange."
        },
        "SEC_SECURITY_CD": {
          "type": "string",
          "description": "Citi Internal Security Code 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."
        },
        "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."
        }
      }
    }
  }
}