Closed OptionSelect closed 5 months ago
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:
Here is a comprehensive list of the data points and objects in the provided Financial Status Report (FSR) JSON object:
view:enhancedFinancialStatusReport
: booleanview:streamlinedWaiver
: booleanview:streamlinedWaiverAssetUpdate
: booleanview:reviewPageNavigationToggle
: booleanquestions
:
hasRepayments
: booleanhasCreditCardBills
: booleanhasRecreationalVehicle
: booleanhasVehicle
: booleanhasRealEstate
: booleanspouseHasBenefits
: booleanisMarried
: booleanhasDependents
: stringhasBeenAdjudicatedBankrupt
: booleanvetIsEmployed
: booleanspouseIsEmployed
: booleanview:components
:
view:contractsAdditionalInfo
: objectview:recVehicleInfo
: objectview:realEstateAdditionalInfo
: objectview:maritalStatus
: objectview:veteranInfo
: objectview:dependentsAdditionalInfo
: objectview:vaBenefitsOnFile
: objectassets
:
recVehicleAmount
: stringrealEstateValue
: stringmonetaryAssets
: array of objectsname
: stringamount
: stringotherAssets
: array of objectsname
: stringamount
: stringautomobiles
: array of objectsmake
: stringmodel
: stringresaleValue
: stringbenefits
:
spouseBenefits
:compensationAndPension
: stringeducation
: stringpersonalData
:
spouseFullName
:first
: stringlast
: stringveteranFullName
:first
: stringlast
: stringmiddle
: stringdateOfBirth
: stringveteranContactInformation
:email
: stringmobilePhone
: object
address
: object
dependents
: array of objectsdependentAge
: stringaddress
:street
: stringcity
: string state
: stringcountry
: stringpostalCode
: stringtelephoneNumber
: stringemailAddress
: stringemploymentHistory
:veteran
:
employmentRecords
: array of objectsspouse
:
spEmploymentRecords
: array of objectspersonalIdentification
:
ssn
: stringfileNumber
: stringselectedDebtsAndCopays
: array of objects
additionalIncome
:
addlIncRecords
: array of objectsname
: stringamount
: stringspouse
:spAddlIncome
: array of objects
name
: stringamount
: stringexpenses
:
expenseRecords
: array of objectsname
: stringamount
: stringcreditCardBills
: array of objectsutilityRecords
: array of objects
name
: stringamount
: stringotherExpenses
: array of objects
name
: stringamount
: stringadditionalData
:
bankruptcy
:dateDischarged
: stringcourtLocation
: stringdocketNumber
: stringadditionalComments
: stringincome
: array of objects
veteranOrSpouse
: stringgmtData
:
isEligibleForStreamlined
: booleangmtThreshold
: nullerror
:error
: stringinstallmentContracts
: array of objects
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:
hasDependentDebts
: booleandebts
: array of objects
fileNumber
: stringpayeeNumber
: stringpersonEntitled
: stringdeductionCode
: stringbenefitType
: stringdiaryCode
: stringdiaryCodeDescription
: string (optional)description
: string (optional)amountOverpaid
: numberamountWithheld
: numberoriginalAr
: numbercurrentAr
: numberdebtHistory
: array of objectsdate
: stringletterCode
: stringdescription
: stringThe 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
.
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.
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
Acceptance criteria