[CDP & FSR] - List Data Points and Structure

[OptionSelect]

Description

For CDP and FSR list all the related data points and objects associated with the submission and retrieval of necessary data for each application. This may include a sample object structure for each application.

Tasks

• [x] CDP data points and object listed
• [x] FSR data points and object listed

Acceptance criteria

• [x] CDP data points and object listed
• [x] FSR data points and object listed

[amponce]

Sample Object Structure for FSR

{
  "personalData": {
    "veteranContactInformation": {
      "email": "email@example.com",
      "mobilePhone": "123-456-7890",
      "address": "123 Main St, City, State, ZIP"
    },
    "employmentHistory": {
      "employmentRecords": [
        {
          "employer": "Company A",
          "position": "Developer",
          "startDate": "2020-01-01",
          "endDate": "2022-01-01",
          "isCurrent": true
        }
      ],
      "spEmploymentRecords": [
        {
          "employer": "Company B",
          "position": "Designer",
          "startDate": "2019-01-01",
          "endDate": "2021-01-01",
          "isCurrent": false
        }
      ]
    }
  },
  "questions": {
    "vetIsEmployed": true,
    "spouseIsEmployed": false,
    "hasDependents": true,
    "hasBeenAdjudicatedBankrupt": true
  },
  "reviewNavigation": true,
  "assets": {
    "monetaryAssets": [
      {
        "name": "Cash in Bank",
        "amount": "5000"
      },
      {
        "name": "Cash on Hand",
        "amount": "200"
      }
    ],
    "otherAssets": [
      {
        "name": "Car",
        "amount": "15000"
      }
    ],
    "automobiles": [
      {
        "name": "Toyota",
        "amount": "10000"
      }
    ]
  },
  "expenses": {
    "creditCardBills": [
      {
        "name": "Visa",
        "amount": "2000"
      }
    ],
    "installmentContracts": [
      {
        "name": "Car Loan",
        "amount": "10000"
      }
    ],
    "otherExpenses": [
      {
        "name": "Gym Membership",
        "amount": "50"
      }
    ],
    "utilityRecords": [
      {
        "name": "Electricity",
        "amount": "100"
      }
    ]
  },
  "additionalIncome": {
    "addlIncRecords": [
      {
        "name": "Freelance",
        "amount": "1000"
      }
    ],
    "spAddlIncome": [
      {
        "name": "Side Job",
        "amount": "500"
      }
    ]
  },
  "gmtData": {
    "incomeBelowGmt": true,
    "incomeBelowOneFiftyGmt": false,
    "assetsBelowGmt": false,
    "liquidAssetsBelowGmt": false,
    "discretionaryBelow": true,
    "cashBelowGmt": true
  },
  "additionalData": {
    "additionalComments": "No additional comments",
    "bankruptcy": {
      "dateDischarged": "2020-01-01",
      "courtLocation": "City Court",
      "docketNumber": "12345"
    }
  }
}

Here is the markdown version:

Detailed Data Points and Objects:

Here is a comprehensive list of the data points and objects in the provided Financial Status Report (FSR) JSON object:

Top-level Data Points:

• view:enhancedFinancialStatusReport: boolean
• view:streamlinedWaiver: boolean
• view:streamlinedWaiverAssetUpdate: boolean
• view:reviewPageNavigationToggle: boolean

Questions:

• questions:
  • hasRepayments: boolean
  • hasCreditCardBills: boolean
  • hasRecreationalVehicle: boolean
  • hasVehicle: boolean
  • hasRealEstate: boolean
  • spouseHasBenefits: boolean
  • isMarried: boolean
  • hasDependents: string
  • hasBeenAdjudicatedBankrupt: boolean
  • vetIsEmployed: boolean
  • spouseIsEmployed: boolean

View Components:

• view:components:
  • view:contractsAdditionalInfo: object
  • view:recVehicleInfo: object
  • view:realEstateAdditionalInfo: object
  • view:maritalStatus: object
  • view:veteranInfo: object
  • view:dependentsAdditionalInfo: object
  • view:vaBenefitsOnFile: object

Assets:

• assets:
  • recVehicleAmount: string
  • realEstateValue: string
  • monetaryAssets: array of objects
  • name: string
  • amount: string
  • otherAssets: array of objects
  • name: string
  • amount: string
  • automobiles: array of objects
  • make: string
  • model: string
  • resaleValue: string

Benefits:

• benefits:
  • spouseBenefits:
  • compensationAndPension: string
  • education: string

Personal Data:

• personalData:
  • spouseFullName:
  • first: string
  • last: string
  • veteranFullName:
  • first: string
  • last: string
  • middle: string
  • dateOfBirth: string
  • veteranContactInformation:
  • email: string
  • mobilePhone: object
    • (multiple fields)
  • address: object
    • (multiple fields)
  • dependents: array of objects
  • dependentAge: string
  • address:
  • street: string
  • city: string
  • state: string
  • country: string
  • postalCode: string
  • telephoneNumber: string
  • emailAddress: string
  • employmentHistory:
  • veteran:
    • employmentRecords: array of objects
    • (multiple fields)
  • spouse:
    • spEmploymentRecords: array of objects
    • (multiple fields)

Personal Identification:

• personalIdentification:
  • ssn: string
  • fileNumber: string

Selected Debts and Copays:

• selectedDebtsAndCopays: array of objects
  • (multiple fields)

Additional Income:

• additionalIncome:
  • addlIncRecords: array of objects
  • name: string
  • amount: string
  • spouse:
  • spAddlIncome: array of objects
    • name: string
    • amount: string

Expenses:

• expenses:
  • expenseRecords: array of objects
  • name: string
  • amount: string
  • creditCardBills: array of objects
  • (multiple fields)

Utility Records:

• utilityRecords: array of objects
  • name: string
  • amount: string

Other Expenses:

• otherExpenses: array of objects
  • name: string
  • amount: string

Additional Data:

• additionalData:
  • bankruptcy:
  • dateDischarged: string
  • courtLocation: string
  • docketNumber: string
  • additionalComments: string

Income:

• income: array of objects
  • veteranOrSpouse: string

GMT Data:

• gmtData:
  • isEligibleForStreamlined: boolean
  • gmtThreshold: null
  • error:
  • error: string

Installment Contracts:

• installmentContracts: array of objects

  • (multiple fields)

  ---

[amponce]

data.md

Spider results for all SetFormData content

[amponce]

CDP Data Points

Example data that we currently use

[
  {
    "file_number": "string",
    "payee_number": "string",
    "person_entitled": "string",
    "deduction_code": "string",
    "benefit_type": "string",
    "amount_overpaid": "string",
    "amount_withheld": "string",
    "debt_history": [
      {
        "date": "string",
        "letter_code": "string",
        "status": "string",
        "description": "string"
      }
    ]
  }
]

Debt letters

[
  {
    "document_id": "string",
    "doc_type": "string",
    "type_description": "string",
    "received_at": "string"
  }
]

Debt Portal Here is the detailed structure of the provided JSON object in markdown format:

Top-level Data Points:

• hasDependentDebts: boolean

Debts:

• debts: array of objects
  • fileNumber: string
  • payeeNumber: string
  • personEntitled: string
  • deductionCode: string
  • benefitType: string
  • diaryCode: string
  • diaryCodeDescription: string (optional)
  • description: string (optional)
  • amountOverpaid: number
  • amountWithheld: number
  • originalAr: number
  • currentAr: number
  • debtHistory: array of objects
  • date: string
  • letterCode: string
  • description: string

The object contains a hasDependentDebts boolean field at the top level, and a debts array which holds multiple debt objects. Each debt object contains various fields related to the debt, such as fileNumber, payeeNumber, personEntitled, deductionCode, benefitType, diaryCode, diaryCodeDescription (optional), description (optional), amountOverpaid, amountWithheld, originalAr, and currentAr.

[amponce]

FSR data structure documentation created: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/teams/vsa/teams/benefits-memorials-2/engineering/front-end/fsr-data-structure.md

CDP data structure documentation created: https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/teams/vsa/teams/benefits-memorials-2/engineering/front-end/cdp-data-structure.md

Next steps Create discovery ticket to determine the exact data being used in the combined debt portal, this might involve a more extensive audit and connecting with someone from the backend team.