API Reference

Get Income Sources

Retrieve paginated list of income sources. Permission: Read Income Sources

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=5

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string
Defaults to sort=+createdAt

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string
Defaults to createdAt=eq:2022-01-01

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

string

The date of the paycheck after the next one. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

When the income source was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The UUID of the customer this income source belongs to. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The name of the customer's employer. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The employment basis. Possible values: Full-Time, Part-Time. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's job title. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The date the customer was most recently paid. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

The most recent paycheck amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

The gross monthly income in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

The number of months employed. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The date the customer will next be paid. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

How often the customer is paid. Possible values: days, weekly, bi-weekly, semi-monthly, monthly. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The method by which the customer receives pay (e.g., Direct Deposit, Check). Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The salary basis. Possible values: Hourly, Salaried. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The second most recent payday. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

The second most recent paycheck amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The type of income source (e.g., Employment, Self-Employment, Social Security, Disability, Pension). Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The third most recent payday. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

When the income source was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The income source's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The customer's work phone number. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The customer's work shift. Possible values: Day, Afternoon, Night, Rotating, Split. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json