The paychecks endpoint provides detailed information about paychecks. You can retrieve individual paycheck details, including the person and job associated with the paycheck, its status, pay period, expected deposit date, total debited amount, withholdings, earnings, and currency.
Functionality: Retrieve specific paycheck details, including payee and job information, and monitor the status and financial details of each paycheck.
Returns details about a paycheck object.
DailyPay-API-Version | integer Default: 3 The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used. Example: 3 |
Accept required | string The media type of the requested payload. This should be set to Value: "application/vnd.api+json" |
Returns the paycheck object.
Bad Request
Invalid authentication credentials
Not authorized to perform this operation
Resource was not found
Unexpected error occured
{- "data": {
- "type": "paychecks",
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "attributes": {
- "status": "ESTIMATED",
- "pay_period_ends_at": "2023-03-15T04:00:00Z",
- "pay_period_starts_at": "2023-03-15T04:00:00Z",
- "deposit_expected_at": "2023-03-15T04:00:00Z",
- "total_debited": 0,
- "gross_earnings": 0,
- "employer_withholdings": 0,
- "net_earnings": 0,
- "currency": "USD"
}, - "relationships": {
- "person": {
- "data": {
- "type": "people",
- "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
}
}, - "job": {
- "data": {
- "type": "jobs",
- "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
}
}
}
}
}
Returns a collection of paycheck objects. This object details a person's pay and pay period. See Filtering Paychecks for a description of filterable fields.
DailyPay-API-Version | integer Default: 3 The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used. Example: 3 |
Accept required | string The media type of the requested payload. This should be set to Value: "application/vnd.api+json" |
Returns the paycheck object.
Bad Request
Invalid authentication credentials
Not authorized to perform this operation
Unexpected error occured
{- "data": [
- {
- "type": "paychecks",
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "attributes": {
- "status": "ESTIMATED",
- "pay_period_ends_at": "2023-03-15T04:00:00Z",
- "pay_period_starts_at": "2023-03-15T04:00:00Z",
- "deposit_expected_at": "2023-03-15T04:00:00Z",
- "total_debited": 0,
- "gross_earnings": 0,
- "employer_withholdings": 0,
- "net_earnings": 0,
- "currency": "USD"
}, - "relationships": {
- "person": {
- "data": {
- "type": "people",
- "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
}
}, - "job": {
- "data": {
- "type": "jobs",
- "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
}
}
}
}
]
}