logo

Paychecks

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.

Get a Paycheck object

Returns details about a paycheck object.

Securityoauth_user_token
Request
path Parameters
paycheck_id
required
string <uuid>

Unique ID of the paycheck

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
header Parameters
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 application/vnd.api+json to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org.

Value: "application/vnd.api+json"
Responses
200

Returns the paycheck object.

Response Schema: application/vnd.api+json
required
object (PaycheckResource)
type
required
string
Value: "paychecks"
id
required
string <uuid>
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
required
object (PaycheckAttributes)
status
required
string

A paycheck expected for an open pay period will have the status ESTIMATED. At the end of the pay period, the paycheck will begin PROCESSING. When it is sent, it will become IN_TRANSIT. Finally, once deposited in an account it will have the status DEPOSITED.

Enum: "ESTIMATED" "PROCESSING" "IN_TRANSIT" "DEPOSITED"
pay_period_ends_at
required
string <date-time>

An ISO 8601 timestamp denoting the ending day of a paycheck's pay period. For example, a pay period that ends during the day of March 15 will have a value of 2023-03-15T04:00:00Z.

Example: "2023-03-15T04:00:00Z"
pay_period_starts_at
required
string <date-time>

An ISO 8601 timestamp denoting the first day of a paycheck's pay period. For example, a pay period that starts during the day of March 15 will have a value of 2023-03-15T04:00:00Z.

Example: "2023-03-15T04:00:00Z"
deposit_expected_at
required
string <date-time>

An ISO 8601 timestamp denoting the day the paycheck is scheduled to be delivered.

Example: "2023-03-15T04:00:00Z"
total_debited
required
integer or null >= 0

The amount debited and settled from this paycheck prior to the end of the pay period. Debits are settled during a pay period in order to cover withdrawals from an earnings balance account. This amount is given as a monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { total_debited: 7050 } with currency USD resolves to $70.50.

Example: 0
gross_earnings
required
integer

The total earnings for this paycheck before any deductions are applied. This amount is given as a monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { gross_earnings: 55370 } with currency USD resolves to $553.70

Example: 0
employer_withholdings
integer or null

The amount withheld from this paycheck by the employer, usually for taxes. This amount is given as a monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { withholdings: 5000 } with currency USD resolves to $50.00.

Example: 0
net_earnings
integer or null

The net earnings for the paycheck once settled given in a monetary quantity expressed in units of the lowest denomination in the associated currency. For example, { earnings: 50370 } with currency USD resolves to $503.70.

Example: 0
currency
required
string (Currency)

A three-letter ISO 4217 currency code. For example, USD for US Dollars, EUR for Euros, or JPY for Japanese Yen.

required
object (PaycheckLinks)
self
required
string <uri> (PaycheckLink)
required
object (PaycheckRelationships)
required
object (PersonRelationship)
required
object (JobRelationship)
400

Bad Request

401

Invalid authentication credentials

403

Not authorized to perform this operation

404

Resource was not found

500

Unexpected error occured

get/rest/paychecks/{paycheck_id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "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"
      },
    • "links": {},
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
      • "job": {
        • "data": {
          • "type": "jobs",
          • "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
          }
        }
      }
    }
}
Get a list of paycheck objects
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.


Securityoauth_user_token 
Request 
query Parameters
filter
string
  Examples: 
filter=job_id:"aa860051-c411-4709-9685-c1b716df611b"
filter=status:"DEPOSITED"
header Parameters
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 application/vnd.api+json to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.


 
 Value:  "application/vnd.api+json"
Responses 
200
Returns the paycheck object.


Response Schema: application/vnd.api+json
required
Array of objects (PaycheckResource) 
 
 Array 
type
required
string
 
 Value:  "paychecks"
id
required
string <uuid> 
 
 Example:  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
required
object (PaycheckAttributes) 
 
required
object (PaycheckLinks) 
 
required
object (PaycheckRelationships) 
 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


500
Unexpected error occured


get/rest/paychecks
Request samples 
Response samples 
application/vnd.api+json
{
  • "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"
        },
      • "links": {},
      • "relationships": {
        • "person": {
          • "data": {
            }
          },
        • "job": {
          • "data": {
            }
          }
        }
      }
    ]
}
➔ Next to People