While /addCoapplicant creates households out of applicants, /getHousehold is a way to view an amalgamted income report.
Any guids that are input in getHousehold will have de-dupliaction run on them, ensuring that income is not double counted.
{
"guid" : [
"Z0xWpCdAs3os520GO4viNI8Ja7t6hRkGmmPxsgGY6cfznBXF1ZaBONDKuEzm",
"PdlSHbkvwyzyKXtn4hLxhZPuG5eyJi9zlljMv79rUORjIOU6PaqjgZfN8kTH"
]
}
Example Response
{
"type": "Household",
"applicantData": {
"householdApplicationCompletion": false,
"totalAssets": 1345.32,
"totalIDVerification": false,
"netHouseholdMonthlyIncome": 5196.82,
"grossHouseholdAnnualIncome": 90511.3,
"rentBudget": 0,
"incomeApproval": false,
"applicants": {
"PdlSHbkvwyzyKXtn4hLxhZPuG5eyJi9zlljMv79rUORjIOU6PaqjgZfN8kTH": {
"applicantType": "standard",
"applicationStatus": "Complete",
"assets": 1392,
"behavior": 84,
"idVerification": "unverified",
"netMonthlyIncome": 0,
"grossMonthlyIncome": 0,
"incomeSources": []
},
"Z0xWpCdAs3os520GO4viNI8Ja7t6hRkGmmPxsgGY6cfznBXF1ZaBONDKuEzm": {
"applicantType": "standard",
"applicationStatus": "Complete",
"assets": 215,
"behavior": 78,
"idVerification": "unverified",
"netMonthlyIncome": 5196.82,
"grossMonthlyIncome": "7,542.61",
"incomeSources": [
{
"id": 37815,
"employer_name": null,
"company_name": null,
"government_name": null,
"description": "Daniella Home He Dir",
"source_description": "",
"num_transactions": 57,
"date_of_last_transaction": "2023-10-10T00:00:00.000000Z",
"date_of_first_transaction": "2022-08-10T00:00:00.000000Z",
"average_monthly_income": "3557.85",
"average_monthly_income_gross": 0,
"income_cadence": null,
"amount_last_payment": "1549.24",
"supervisor_name": null,
"supervisor_phone": null,
"supervisor_email": null,
"job_title": null,
"start_date": null,
"end_date": null,
"source_type": "employment",
"applicant_comment": null,
"added_by": "system",
"supported_by_transactions": 1,
"type_of_income": "employment",
"verified": false,
"completed": false,
"removed_by_user": false,
"date_range_used": {
"average": 3557.851400000412,
"months": 3.22580645161253,
"first": "2023-07-25T00:00:00.000000Z",
"last": "2023-10-31T23:59:59.999999Z"
},
"date_range_total": {
"first": "2022-08-10T00:00:00.000000Z",
"last": "2023-10-10T00:00:00.000000Z",
"months": 14
},
"leaving_soon": 0,
"contact_consent": 0
},
{
"id": 37816,
"employer_name": null,
"company_name": null,
"government_name": null,
"description": "Communicatio Payroll",
"source_description": "",
"num_transactions": 3,
"date_of_last_transaction": "2023-10-06T00:00:00.000000Z",
"date_of_first_transaction": "2023-09-08T00:00:00.000000Z",
"average_monthly_income": "1449.01",
"average_monthly_income_gross": 0,
"income_cadence": null,
"amount_last_payment": "1057.97",
"supervisor_name": null,
"supervisor_phone": null,
"supervisor_email": null,
"job_title": null,
"start_date": null,
"end_date": null,
"source_type": "employment",
"applicant_comment": null,
"added_by": "system",
"supported_by_transactions": 1,
"type_of_income": "employment",
"verified": false,
"completed": false,
"removed_by_user": false,
"date_range_used": {
"average": 1449.0132727275777,
"months": 1.7741935483867233,
"first": "2023-09-08T00:00:00.000000Z",
"last": "2023-10-31T23:59:59.999999Z"
},
"date_range_total": {
"first": "2023-09-08T00:00:00.000000Z",
"last": "2023-10-06T00:00:00.000000Z",
"months": 0.9279569892473118
},
"leaving_soon": 0,
"contact_consent": 0
},
{
"id": 37817,
"employer_name": null,
"company_name": null,
"government_name": null,
"description": "Pulsz",
"source_description": null,
"num_transactions": 4,
"date_of_last_transaction": "2023-10-02T00:00:00.000000Z",
"date_of_first_transaction": "2023-09-28T00:00:00.000000Z",
"average_monthly_income": "189.96",
"average_monthly_income_gross": 0,
"income_cadence": null,
"amount_last_payment": "19.99",
"supervisor_name": null,
"supervisor_phone": null,
"supervisor_email": null,
"job_title": null,
"start_date": null,
"end_date": null,
"source_type": "other",
"applicant_comment": null,
"added_by": "system",
"supported_by_transactions": 1,
"type_of_income": "other",
"verified": false,
"completed": false,
"removed_by_user": false,
"date_range_used": {
"average": 189.96,
"months": 1,
"first": "2023-09-28T00:00:00.000000Z",
"last": "2023-10-02T00:00:00.000000Z"
},
"date_range_total": {
"first": "2023-09-28T00:00:00.000000Z",
"last": "2023-10-02T00:00:00.000000Z",
"months": 0.13225806451612904
}
}
]
}
},
"duplicateIncomeSources": []
}
}