Get gross monthly income broken down by base, commission, bonus and overtime as well as gross annual income for one or more persons' by using their paystubs.
This endpoint is in beta!
This endpoint is currently in beta, and is therefore subject to change. We would greatly appreciate it if you reported any feedback (including bugs) to customer service.
General calculations:
- We differentiate between multiple borrowers within a single book when calculating income
- If any paystubs have overlapping time periods, we aggregate incomes of the same type (eg. base, overtime, bonus, commission pay)
The paystub income response
Attribute name | Attribute data type | Attribute description |
|---|---|---|
book_uuid | UUID | A universally unique identifier assigned to the Book when it was created. |
person.name | string | The person who's income is estimated in this object. |
person.matched_names | array of strings | The names found on paystubs that we associated to this person. |
calculated_at | timestamp | Time at which the calculations were run. |
currency | currency | Three-letter ISO currency code in which we estimated the person's income. |
estimated_gross_income.monthly_base | string | The person's average base pay for a month. Calculations details below. For each paystub a borrower submitted:
Final gross monthly base = the average of all paystub’s monthly base pay |
estimated_gross_income.monthly_overtime | string | The person's average overtime pay for a month. Calculations details below. For each paystub a borrower submitted:
Final gross monthly overtime = the average of all paystub’s monthly overtime pay |
estimated_gross_income.monthly_bonus | string | The person's average bonus pay for a month. Calculations details below. Calculate the sum of all bonus pay found in paystubs in a single tax year. Final gross monthly bonus = that sum divided by 12 |
estimated_gross_income.monthly_commission | string | The person's average commission pay for a month. Calculations details below. For each paystub a borrower submitted:
Final gross monthly commission = the average of all paystub’s monthly commission pay |
estimated_gross_income.annual_income | string | The person's estimated annual income. Calculations details below. Final gross annual income = (monthly base + bonus + overtime + commission) * 12 |