Get Pay Statement

Get Pay Statement

Use this endpoint to retrieve employee-level pay statement details for one or more payruns in a single batch call.

Key Points

• Batch request — Request multiple payruns in one call by adding multiple objects to the requests array.
• Depends on — payment_id values from GET /payroll/payment.
• Monetary values — All amounts are in cents (e.g. 500000 = $5,000.00).

POST payroll/pay-statement 

Header Parameters

Field	Type	Description
Authorization	string	Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-Version	string	API version string. Use 1.0.0.

Query Parameters

Field	Type	Description
entity_ids	string	Required. The organization ID. Must be exactly one UUID.

Request Body

Field	Type	Description
requests	object[]	Array of payruns to look up. Add multiple objects to request several payruns in one call.
payment_id	string	The payrun UUID from GET /payroll/payment.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP status code (e.g. 200).
message	string	Human-readable status message.
response	object[]	One entry per requested payrun.
payment_id	string	The payrun UUID.
body	object	Pay statement data for this payrun.
pay_statements	object[]	Per-employee pay statements for the payrun.
individual_id	string	The employee UUID.
type	string	Payroll type. One of regular_payroll, off_cycle, bonus.
payment_method	string	Payment method. One of check, direct_deposit.
total_hours	number	Total hours worked. null for salaried employees.
gross_pay	object	Gross pay for the pay period.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
net_pay	object	Net (take-home) pay for the pay period.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
earnings	object[]	Earnings line items.
type	string	Earning type. One of salary, hourly, bonus, commission, other.
name	string	Display name of the earning.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
hours	number	Hours attributed to this earning. null if not applicable.
taxes	object[]	Tax line items.
type	string	Tax type. One of federal, state, local.
name	string	Display name of the tax.
employer	boolean	true if this is an employer-side tax; false for employee-side.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
employee_deductions	object[]	Pre/post-tax deductions withheld from the employee.
name	string	Deduction name (e.g. Medical, 401k).
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
pre_tax	boolean	true if deducted before tax.
type	string	Deduction type identifier.
employer_contributions	object[]	Employer-side benefit contributions.
name	string	Contribution name (e.g. Medical, 401k Match).
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
type	string	Contribution type identifier.

Payload

Request Json

Sample	Description	Action
Sample 1	Look up pay statements for one payrun. Add multiple objects to the requests array to batch several payruns.

Sample 1

{
  "requests": [
    {
      "payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"
    }
  ]
}

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests. All monetary values are in cents.
400	Bad Request Response - You'll get the below response when the request body fails validation.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": [
    {
      "payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
      "body": {
        "pay_statements": [
          {
            "individual_id": "be7b048c-a6f3-4194-a017-2f537d4f3565",
            "type": "regular_payroll",
            "payment_method": "direct_deposit",
            "total_hours": 42.5,
            "gross_pay": {
              "amount": 230000,
              "currency": "usd"
            },
            "net_pay": {
              "amount": 180000,
              "currency": "usd"
            },
            "earnings": [
              {
                "type": "salary",
                "name": "Regular Salary",
                "amount": 230000,
                "currency": "usd",
                "hours": 42.5
              }
            ],
            "taxes": [
              {
                "type": "state",
                "name": "State Withholding",
                "employer": false,
                "amount": 0,
                "currency": "usd"
              }
            ],
            "employee_deductions": [
              {
                "name": "Pre-Tax 401k",
                "amount": 50000,
                "currency": "usd",
                "pre_tax": true,
                "type": "401k"
              }
            ],
            "employer_contributions": [
              {
                "name": "Employee Medical Insurance",
                "amount": 23272,
                "currency": "usd",
                "type": "s125_medical"
              }
            ]
          }
        ]
      }
    }
  ]
}