# Get a Paycheck object

Returns details about a paycheck object.

Endpoint: GET /rest/paychecks/{paycheck_id}
Version: 3.0.0-beta01
Security: oauth_user_token

## Header parameters:

  - `DailyPay-API-Version` (integer)
    The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

  - `Accept` (string)
    The media type of the requested payload. This should be set to  to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.
    Enum: "application/vnd.api+json", "*/*"

## Path parameters:

  - `paycheck_id` (string, required)
    Unique ID of the paycheck
    Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

## Response 200 fields (application/vnd.api+json):

  - `data` (object, required)

  - `data.type` (string, required)

  - `data.id` (string, required)
    Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

  - `data.attributes` (object, required)

  - `data.attributes.status` (string, required)
    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"

  - `data.attributes.pay_period_ends_at` (string, required)
    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"

  - `data.attributes.pay_period_starts_at` (string, required)
    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"

  - `data.attributes.deposit_expected_at` (string, required)
    An ISO 8601 timestamp denoting the day the paycheck is scheduled to be delivered.
    Example: "2023-03-15T04:00:00Z"

  - `data.attributes.total_debited` (integer,null, required)
    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.

  - `data.attributes.gross_earnings` (integer, required)
    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

  - `data.attributes.employer_withholdings` (integer,null, required)
    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.

  - `data.attributes.net_earnings` (integer,null, required)
    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.

  - `data.attributes.currency` (string, required)
    A three-letter ISO 4217 currency code. For example,  for US Dollars,  for Euros, or  for Japanese Yen.

  - `data.links` (object, required)

  - `data.links.self` (string, required)

  - `data.relationships` (object, required)

  - `data.relationships.person` (object, required)

  - `data.relationships.job` (object, required)

## Response 400 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.code` (string, required)
    A code that indicates what went wrong. Please consider this an open enum, where new codes may be added over time.
    Example: "INVALID_PARAMETERS"

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

## Response 401 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "INVALID_TOKEN", "UNAUTHORIZED"

## Response 403 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "FORBIDDEN"

## Response 404 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "RECORD_NOT_FOUND", "NOT_FOUND"

## Response 500 fields (application/vnd.api+json):

  - `errors` (array, required)
    A list of errors that occurred.

  - `errors.status` (string, required)
    The HTTP status code for the error.
    Example: "400"

  - `errors.detail` (string, required)
    A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change
    Example: "The request failed because it was not in the correct format or did not contain valid data."

  - `errors.links` (object, required)
    A list of links to resources that may be helpful in resolving the error.

  - `errors.links.about` (string)
    Example: "https://developer.dailypay.com/tag/Errors"

  - `errors.source` (object)
    Location in the request that may have caused the error.

  - `errors.source.parameter` (string)
    The name of the parameter that caused the error.
    Example: "filter[first_name]"

  - `errors.source.pointer` (string)
    A JSON Pointer to the location in the request that caused the error.
    Example: "/data/attributes/first_name"

  - `errors.source.header` (string)
    The name of the header that caused the error.
    Example: "Accept"

  - `errors.meta` (object, required)
    Additional information about the error.

  - `errors.meta.request_id` (string)
    A UUID for the originating request.
    Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe"

  - `errors.meta.trace_id` (string)
    An ID used for tracing purposes.
    Example: "4016616108459136584"

  - `errors.code` (string, required)
    A code that indicates what went wrong.
    Enum: "UNEXPECTED_ERROR"