Capture

Book pay stub data

Retrieves pay stub data for a given <glossary:Book>.

A detailed description of the response can be found on the pay stub data type definition.

get/v2/book/{book_uuid}/paystub

Request

Base URL
https://api.ocrolus.com
URL
https://api.ocrolus.com/v2/book/{book_uuid}/paystub
Auth
OAuth 2
Client credentials
Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

book_uuidstring required

The unique identifier of a <glossary:Book> that contains the pay stub data.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "message": "OK",
  "response": [
    {
      "uuid": "ce3585b5-44a0-4273-8ca9-c885a353bd87",
      "book_uuid": "95573c48-93da-472d-ac86-c7e9b58bd53d",
      "doc_uuid": "32765c32-1a15-477a-8a2d-fe8cbe89ac9c",
      "status": "COMPLETED",
      "net_pay": {
        "distribution_details": [
          {
            "description": "FEDERAL CREDIT UNION CHECKING 3328",
            "bank_name": "FEDERAL CREDIT UNION",
            "account_number": "3328",
            "bank_account_type": "CHECKING",
            "current_pay": {
              "amount": "863.60",
              "currency": "USD"
            }
          }
        ],
        "totals": {
          "description": "NET PAY",
          "current_pay": {
            "amount": "863.60",
            "currency": "USD"
          },
          "ytd_pay": {
            "amount": "8952.65",
            "currency": "USD"
          }
        }
      },
      "earnings": {
        "subtotals": [
          {
            "description": "ANNUAL BONUS",
            "canonical_description": "BONUS",
            "current_pay": {
              "amount": "863.60"
            },
            "ytd_pay": {
              "amount": "8952.65",
              "currency": "USD"
            }
          }
        ],
        "totals": [
          {
            "description": "GROSS PAY",
            "canonical_description": "BONUS",
            "current_pay": {
              "amount": "863.60"
            },
            "ytd_pay": {
              "amount": "8952.65",
              "currency": "USD"
            }
          }
        ]
      },
      "deductions": {
        "subtotals": [
          {
            "description": "STATE TAX",
            "canonical_description": "STATE TAX",
            "current_pay": {
              "amount": "863.60"
            },
            "ytd_pay": {
              "amount": "8952.65",
              "currency": "USD"
            }
          }
        ],
        "totals": [
          {
            "description": "STATE TAX",
            "canonical_description": "STATE TAX",
            "current_pay": {
              "amount": "863.60"
            },
            "ytd_pay": {
              "amount": "8952.65",
              "currency": "USD"
            }
          }
        ]
      },
      "employer": {
        "name": "INSTANT CARD NATIONAL",
        "address": {
          "line1": "2712 WHITE RIVER AVE.",
          "city": "OAKLAND",
          "state_code": "CA",
          "postal_code": "94621"
        }
      },
      "employee": {
        "name": "TAMIKA S. NOTE",
        "address": {
          "line1": "4654 SYCAMORE ST.",
          "city": "SAN JOSE",
          "state_code": "CA",
          "postal_code": "95113"
        },
        "marital_status": "SINGLE",
        "taxpayer_id": {
          "id_type": "SSN",
          "last_4_digits": "2323"
        }
      },
      "paystub_details": {
        "pay_period_start_date": "2022-03-04T00:00:00.000Z",
        "pay_period_end_date": "2022-03-17T00:00:00.000Z",
        "pay_date": "2022-03-18T00:00:00.000Z",
        "pay_frequency": "BI_WEEKLY",
        "pay_frequency_captured": "NOT LISTED"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.