> ## Documentation Index
> Fetch the complete documentation index at: https://sdk.transcrypts.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reports

> Report object attributes and data structure for income and employment verification reports

## Attributes

The report response includes the following core fields:

| Attribute       | Type   | Description                                                          |
| --------------- | ------ | -------------------------------------------------------------------- |
| id              | string | Unique identifier                                                    |
| status          | string | Connection status from lifecycle                                     |
| finished\_at    | string | Report completion timestamp                                          |
| completed\_at   | string | Time when report was completed (Deprecated, invalid datetime format) |
| access\_token   | string | Token for payroll provider access                                    |
| tracking\_info  | string | Partner-provided tracking information                                |
| refresh\_status | string | Most recent refresh task status                                      |
| employments     | array  | Employment records list                                              |
| pdf\_report     | uri    | Verification report in PDF                                           |
| provider        | string | Payroll provider name                                                |
| data\_source    | string | "payroll" or "docs"                                                  |

## Employments Object

Contains employment and income details:

| Attribute               | Type    | Description                                                          |
| ----------------------- | ------- | -------------------------------------------------------------------- |
| income                  | string  | Annual income excluding bonuses/commissions                          |
| income\_unit            | string  | YEARLY, MONTHLY, WEEKLY, DAILY, or HOURLY                            |
| pay\_rate               | string  | Payment per cycle amount                                             |
| pay\_frequency          | string  | M, SM, W, BW, A, SA, C values                                        |
| statements              | array   | Pay stub records                                                     |
| annual\_income\_summary | array   | Yearly income breakdown                                              |
| bank\_accounts          | array   | Direct deposit accounts                                              |
| w2s                     | array   | W-2 tax forms                                                        |
| id                      | string  | Unique identifier                                                    |
| is\_active              | boolean | Employment status                                                    |
| job\_title              | string  | Position title                                                       |
| job\_type               | string  | F, P, S, D, or C                                                     |
| start\_date             | date    | Hire date                                                            |
| original\_hire\_date    | date    | Initial employment date                                              |
| end\_date               | date    | Termination date                                                     |
| external\_last\_update  | date    | Indicates date of last updated employment data from Payroll Provider |
| manager\_name           | string  | Supervisor name                                                      |
| profile                 | object  | Identity information                                                 |
| company                 | object  | Employer details                                                     |
| gse\_accepted           | boolean | Fannie Mae eligibility status                                        |

### Company Object

| Attribute | Type   | Description                    |
| --------- | ------ | ------------------------------ |
| name      | string | Company name                   |
| address   | object | Location details               |
| phone     | string | Contact number                 |
| ein       | string | Employer Identification Number |

### Address Object

| Attribute | Type   |
| --------- | ------ |
| street    | string |
| city      | string |
| state     | string |
| zip       | string |
| country   | string |

## Statements Object

Pay stub information structure:

| Attribute       | Type   | Description                  |
| --------------- | ------ | ---------------------------- |
| id              | string | Unique identifier            |
| check\_number   | string | External ID from provider    |
| pay\_date       | date   | Payment date                 |
| net\_pay        | string | Amount after deductions      |
| gross\_pay      | string | Total compensation           |
| bonus           | string | Bonus amount                 |
| commission      | string | Commission amount            |
| hours           | string | Work hours during pay period |
| basis\_of\_pay  | string | S, H, D, or W                |
| period\_start   | date   | Pay period beginning         |
| period\_end     | date   | Pay period ending            |
| earnings        | array  | Earnings by type             |
| earnings\_ytd   | array  | Year-to-date earnings        |
| deductions      | array  | Paycheck deductions          |
| deductions\_ytd | array  | Year-to-date deductions      |
| file            | uri    | Pay stub document link       |

## Annual Income Summary Object

| Attribute  | Type    |
| ---------- | ------- |
| year       | integer |
| regular    | string  |
| bonus      | string  |
| commission | string  |
| overtime   | string  |
| other\_pay | string  |
| net\_pay   | string  |
| gross\_pay | string  |

## Bank Accounts Object

| Attribute       | Type   | Description                 |
| --------------- | ------ | --------------------------- |
| account\_number | string | Account identifier          |
| routing\_number | string | Bank routing number         |
| account\_name   | string | User-friendly name          |
| account\_type   | string | C (Checking) or S (Savings) |
| deposit\_type   | string | E, P, or A                  |
| deposit\_value  | string | Amount or percentage        |
| bank\_name      | string | Financial institution       |

## W2s Object

| Attribute               | Type    | Description                                 |
| ----------------------- | ------- | ------------------------------------------- |
| file                    | uri     | W-2 document link                           |
| year                    | integer | Tax year                                    |
| wages                   | string  | Wages, tips, other compensation (Section 1) |
| federal\_tax            | string  | Federal withholding amount                  |
| social\_security\_wages | string  | Social Security taxable wages               |
| medicare\_wages         | string  | Medicare taxable wages                      |
| gross\_pay              | string  | Total compensation                          |

## Earnings Object

Earnings array structure with supported categories: `regular`, `bonus`, `commission`, `overtime`, `other_pay`.

```json theme={null}
[
  {
    "name": "Regular",
    "amount": "38072.0",
    "category": "regular",
    "rate": "475.9",
    "units": "80"
  }
]
```

## Deductions Object

Deductions array with categories: `memo`, `medicare`, `retirement`, `benefit`, `socialsec`, `federal`, `state`, `garnishment`, `local`, `other`.

```json theme={null}
[
  {
    "amount": "127.01",
    "category": "socialsec",
    "name": "Social Security Tax"
  }
]
```

## Endpoints

* [Retrieve employment history report](/income-and-employment/employment-history-report)
* [Retrieve income and employment report](/income-and-employment/income-employment-report)