febf0553-d455-4849-b6fa-2337b4989b0f-json-response-schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-febf0553-d455-4849-b6fa-2337b4989b0f-json-response-schema-schema.json",
  "title": "febf0553-d455-4849-b6fa-2337b4989b0f-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/febf0553-d455-4849-b6fa-2337b4989b0f-json-response-schema",
  "type": "object",
  "properties": {
    "Count": {
      "type": "number",
      "format": "integer"
    },
    "PagedList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/febf0553-d455-4849-b6fa-2337b4989b0f-data-schema"
      }
    }
  },
  "$defs": {
    "febf0553-d455-4849-b6fa-2337b4989b0f-data-schema": {
      "type": "object",
      "properties": {
        "ACCOUNT_CURRENCY": {
          "type": "string",
          "description": "Account Currency is the ISO 4217 currency code corresponding to the base currency of the safekeeping account."
        },
        "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."
        },
        "ACTIVITY_CATEGORY": {
          "type": "string",
          "description": "Activity Category is the low level description of the billable activity (e.g. Asset Services, Settlements, Tax)."
        },
        "ACTIVITY_CURRENCY": {
          "type": "string",
          "description": "Activity Currency is the ISO 4217 currency code corresponding to the market currency of the billable activity."
        },
        "ACTIVITY_TYPE": {
          "type": "string",
          "description": "Activity Type is the high level description of the billable activity (e.g. Valuations, Transactions, Surcharges, Other fees)."
        },
        "CLARITY_BRANCH_NAME": {
          "type": "string",
          "description": "Branch Name is the name of the branch for the Cash Account and/or Safekeeping Account."
        },
        "CHARGE_IN_FEE_CURENCY": {
          "type": "number",
          "format": "double",
          "description": "Charge (Fee Schedule Currency) is the calculated charge for the billable activity in the Fee Schedule Currency."
        },
        "CHARGE_IN_USD": {
          "type": "number",
          "format": "double",
          "description": "Charge (USD) is the calculated charge for the billable activity in US dollars."
        },
        "CLIENT_ID": {
          "type": "string",
          "description": "Client ID is an identifier for the client as set up in the core billing system."
        },
        "DELIVERY_METHOD": {
          "type": "string",
          "description": "Delivery Method indicates how the invoice is sent to the client. E.g. By post, by email, etc."
        },
        "DIRECT_DEBIT_CASH_ACCOUNT": {
          "type": "string",
          "description": "Direct Debit Cash Account is the account id of the cash account from which the invoice amount will be debited."
        },
        "DIRECT_DEBIT_SLA_DATE": {
          "type": "string",
          "description": "Direct Debit SLA is the date on which the direct debit is expected to be taken."
        },
        "FEE_SCHEDULE_CURRENCY": {
          "type": "string",
          "description": "Fee Schedule Currency is the ISO 4217 currency code corresponding to the currency in which the rate card is published."
        },
        "INVOICE_CURRENCY": {
          "type": "string",
          "description": "Invoice Currency is the ISO 4217 currency code corresponding to the currency in which the invoice is to be paid."
        },
        "INVOICE_DELIVERY_DATE": {
          "type": "string",
          "format": "date",
          "description": "Invoice Delivery Date is the date on which the invoice was sent to the client."
        },
        "BILLING_FREQUENCY": {
          "type": "string",
          "description": "Invoice Frequency indicates how often the invoice is calculated. E.g. Monthly, Quarterly, etc."
        },
        "BILLABLE_MONTH": {
          "type": "string",
          "format": "date",
          "description": "Represents the billing month for which the invoice is generated. The date typically reflects a day within the billable month."
        },
        "BILLING_PERIOD": {
          "type": "string",
          "format": "date",
          "description": "Represents the specific date or timestamp associated with the billing period used for invoice calculation."
        },
        "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."
        },
        "REPORTING_DATE": {
          "type": "string",
          "format": "date-time",
          "description": "Invoice Update Date is the date on which the invoice was last changed."
        },
        "MARKET": {
          "type": "string",
          "description": "Market is the name of the market or International Central Securities Depositories in which the billable activity has occurred."
        },
        "PAYMENT_BASIS": {
          "type": "string",
          "description": "Payment Basis indicates how the invoice is expected to be paid. e.g. Remittance, Direct Debit."
        },
        "BILLING_CENTRE": {
          "type": "string",
          "description": "Place Of Settlement Code is a 3 digit code corresponding to the settlement location of the holding."
        },
        "BILLING_CENTRE_NAME": {
          "type": "string",
          "description": "Place Of Settlement is the settlement location of the holding."
        },
        "QUANTITY_IN_ACCOUNT_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Quantity (Account Currency) is either the number of charges incurred or the value used in the fee calculation converted to the Account Currency."
        },
        "QUANTITY_IN_FEE_SCHEDULE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Quantity (Activity Currency) is either the number of charges incurred or the value used in the fee calculation converted to the Activity Currency."
        },
        "QUANTITY_IN_INVOICE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Quantity (Invoice Currency) is either the number of charges incurred or the value used in the fee calculation converted to the Invoice Currency."
        },
        "QUANTITY_IN_USD": {
          "type": "number",
          "format": "double",
          "description": "Quantity (USD) is either the number of charges incurred or the value used in the fee calculation converted to US dollars."
        },
        "REGION": {
          "type": "string",
          "description": "Region is the name of the geographical region (if appropriate) in which the billable activity has occurred."
        },
        "REVISED_FLAG": {
          "type": "string",
          "description": "Revised Flag indicates whether or not the invoice has been changed since it was first calculated."
        },
        "REVISION_NUMBER": {
          "type": "integer",
          "format": "int32",
          "description": "Revision Number indicates how many times the invoice has been revised."
        },
        "SALES_TAX_FEE_IN_ACCOUNT_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Sales Tax (Account Currency) is the applicable sales tax in the Account Currency."
        },
        "SALES_TAX_FEE_IN_FEE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Sales Tax (Fee Schedule Currency) is the applicable sales tax in the Fee Schedule Currency."
        },
        "SALES_TAX_FEE_IN_INVOICE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Sales Tax (Invoice Currency) is the applicable sales tax in the Invoice Currency."
        },
        "SALES_TAX_FEE_IN_USD": {
          "type": "number",
          "format": "double",
          "description": "Sales Tax (USD) is the applicable sales tax in US Dollars."
        },
        "TOTAL_FEE_IN_ACCOUNT_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Total Fee (Account Currency) is the total charge for the billable activity in the Account Currency."
        },
        "TOTAL_FEE_IN_FEE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Total Fee (Fee Schedule Currency) is the total charge for the billable activity in the Fee Schedule Currency."
        },
        "TOTAL_FEE_IN_INVOICE_CURRENCY": {
          "type": "number",
          "format": "double",
          "description": "Total Fee (Invoice Currency) is the total charge for the billable activity in the Invoice Currency."
        },
        "TOTAL_FEE_IN_USD": {
          "type": "number",
          "format": "double",
          "description": "Total Fee (USD) is the total charge for the billable activity in US Dollars."
        },
        "INVOICE_YEAR": {
          "type": "string",
          "description": "Represents the calendar year in which the custody invoice is generated."
        },
        "INVOICE_MONTH": {
          "type": "string",
          "description": "Billable Invoice Month."
        },
        "CATEGORY_CODE": {
          "type": "string",
          "description": "Category Code."
        },
        "TRANSACTION_TYPE": {
          "type": "string",
          "description": "Type of transaction. List of available values: 'AllocBuyExt':'Buy Future':'Open Repo':'Open Reverse':'Buy TBA':'Buy Protection':'MatRepo':'IssueFunds':'OpenSwap':'Buy Option':'Assignment':'Call on Rights':'Scrip Dividend':'CASell':'Exerc. Opt.':'Expire Option':'CloseFX':'Sell':'VariatMarg':'Buy':'Redemption':'ChargeCash':'MatLend':'Payment':'Coupon':'CALiqu':'IniMar':'Lend':'DepMoney':'Dividend':'Loan Facility Fee Pay In':'Withdraw':'WdrMoney':'MatReverse':'CA Stock split':'CA Reverse stock split':'Rights Distribution':'Exchange Offer':'Deliver Collateral':'RalocCdyPor':'CABuy':'Bonus Issue':'DemergerMor':'DRP Scrip Dividend':'Merger':'Spin Off':'Worthless':'BuyFXSpot':'BuyFXFwd':'SellFXSpot':'SellFXFwd':'Deposit':'Accept Collateral':'Close Facility Commitment':'Open Facility Commitment':'AllocSellExt':'Sell Future':'Sell TBA':'Sell Option':'Close Opt':'BuyFXFwdDbd':'SellFXFwdDbd'."
        },
        "RESPONSIBLE_PERSON": {
          "type": "string",
          "description": "Responsible person."
        },
        "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 Country code."
        },
        "ALTV_CUR_CD": {
          "type": "string",
          "description": "Account Base Currency Code is the ISO 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": "Account Type Code indicates the type of the account. Values are: C (Cash Account), S (Safekeeping Account)."
        },
        "IOD_TIMESTAMP": {
          "type": "string",
          "format": "date-time",
          "description": "Provides the Timestamp when data is loaded in the Data Lake."
        }
      }
    }
  }
}