HomeGuidesAPI ReferenceChangelog

FinancialDetails

Payitoff API: FinancialDetails Schema

🚧

For historical reasons, FinancialDetails are returned as a nested object in Borrower responses. but most properties are accepted as direct BorrowerPayload properties when creating and updating your Borrower via API.

This discrepancy will be corrected in API v2.

Schema Definition

Property

Type

Format

Description

agi

number

float

The Borrower's Adjusted Gross IncomeAdjusted Gross Income - An individual's total gross income minus any specific deductions to which they are entitled or elect..

children

integer

int32

The number of children (including unborn) a Borrower has.

Defaults to 0.

dependents

integer

int32

The number of non-children dependents who receive more than half their support from the Borrower.

Defaults to 0.

employer_state

string

State in which the Borrower's current employer is located.

extra_monthly_payment

number

float

The amount of additional payment, if any, the Borrower wishes to make on their loan(s).

family_size

integer

int32

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 Borrower.

Defaults to 1.

filing_status

string

single
head_of_household
married_filing_jointly
married_filing_separately

Federal tax filing status of Borrower.

Defaults to single.

income_growth

number

float

Expected income growth per year, as a percentage.

Defaults to 5.0.

new_borrower_date

string

date

The date on which the Borrower first took out student loans.

pslf

boolean

Instructs Payitoff to include PSLF forgiveness in Assessment calculations.

Defaults to null.

refinance_rate

number

float

TODO

refinance_term

integer

int32

TODO

related_to_major

boolean

TODO

spouse_agi

number

float

If the Borrower has a spouse, the spouse's Adjusted Gross IncomeAdjusted Gross Income - An individual's total gross income minus any specific deductions to which they are entitled or elect..

NOTE: family_size should be at least 2 if providing spouse_agi to be included in Assessment calculations. You should also choose one of the married_* filing_status values.

state_of_residence

string

State in which the borrower legally resides.

tcli_enabled

boolean

Instructs Payitoff to include TCLI forgiveness in Assessment calculations.

Defaults to null.

tcli_end_year

string

date

TODO

tcli_start_year

string

date

TODO

teaching_level

string

elementary
middle
secondary

If Borrower is a teacher, what level of education they teach.

teaching_state

string

If Borrower is a teacher, the state where employing school is located.

teaching_subject

string

english
math
other
science
special_education

If Borrower is a teacher, the subject they teach.`

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
}

Did this page help you?