FinancialDetails
Payitoff API: FinancialDetails
Schema
For historical reasons,
FinancialDetails
are returned as a nested object inBorrower
responses. but most properties are accepted as directBorrowerPayload
properties when creating and updating yourBorrower
via API.This discrepancy will be corrected in API v2.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
|
|
| The |
|
|
| The number of children (including unborn) a Defaults to |
|
|
| The number of non-children dependents who receive more than half their support from the Defaults to |
|
| State in which the | |
|
|
| The amount of additional payment, if any, the |
|
|
| Number of family members, including the Borrower, their spouse, their children (even unborn), and any other dependents who receive more than half of their support from the Defaults to |
|
|
| Federal tax filing status of Defaults to |
|
|
| Expected income growth per year, as a percentage. Defaults to |
|
|
| The date on which the |
|
| Instructs Payitoff to include PSLF forgiveness in Assessment calculations. Defaults to | |
|
|
| TODO |
|
|
| TODO |
|
| TODO | |
|
|
| If the NOTE: |
|
| State in which the borrower legally resides. | |
|
| Instructs Payitoff to include TCLI forgiveness in Assessment calculations. Defaults to | |
|
|
| TODO |
|
|
| TODO |
|
|
| If |
|
| If | |
|
|
| If |
Example
{
"agi": 45500.44,
"children": 1,
"dependents": 0,
"employer_state": null,
"extra_monthly_payment": 0.00,
"family_size": 2,
"filing_status": "single",
"income_growth": null,
"new_borrower_date": null,
"pslf": null,
"refinance_rate": null,
"refinance_term": null,
"related_to_major": null,
"spouse_agi": 24000.00,
"state_of_residence": "NV",
"tcli_enabled": null,
"tcli_end_year": null,
"tcli_start_year": null,
"teaching_level": null,
"teaching_state": null,
"teaching_subject": null
}
Updated 5 months ago