Get Payment

Get Payment

Use this endpoint to retrieve a list of payrun records for the employer within a date range. Each record represents one completed payrun and includes pay totals, tax amounts, and the employees and pay groups involved. Copy the id values — these are the payment_id values needed by POST /payroll/pay-statement.

GET payroll/payment 

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.
start_date	string	Required. Start of the date range (YYYY-MM-DD). Must be less than or equal to end_date. Filtering is based on the payrun's pay_date.
end_date	string	Required. End of the date range (YYYY-MM-DD), inclusive. Filtering is based on the payrun's pay_date.

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[]	List of payrun records.
id	string	The payrun UUID (payment_id).
pay_period	object	The pay period covered by the payrun.
start_date	string	Start of the pay period (YYYY-MM-DD).
end_date	string	End of the pay period (YYYY-MM-DD).
pay_date	string	The pay date of the payrun (YYYY-MM-DD).
debit_date	string	The date funds are debited (YYYY-MM-DD). Can be null.
company_debit	object	Total amount debited from the company account.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
gross_pay	object	Total gross pay for all employees in this payrun.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
net_pay	object	Total net pay for all employees in this payrun.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
employer_taxes	object	Total employer tax liability for this payrun.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
employee_taxes	object	Total employee tax withheld for this payrun.
amount	number	Amount in cents.
currency	string	ISO currency code (e.g. usd).
individual_ids	string[]	Employee UUIDs included in this payrun.
pay_group_ids	string[]	Pay group UUIDs associated with this payrun.
pay_frequencies	string[]	Pay frequencies used in this payrun (e.g. ["bi_weekly"]).

Payload

Request

GET payroll/payment?entity_ids=519a84f4-...&start_date=2026-01-01&end_date=2026-03-31
Header: X-TaxBandits-Version: 1.0.0

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when entity_ids is missing or the date range is invalid.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": [
    {
      "id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
      "pay_period": {
        "start_date": "2026-01-01",
        "end_date": "2026-01-31"
      },
      "pay_date": "2026-01-31",
      "debit_date": "2026-01-31",
      "company_debit": {
        "amount": 1250000,
        "currency": "usd"
      },
      "gross_pay": {
        "amount": 1000000,
        "currency": "usd"
      },
      "net_pay": {
        "amount": 760000,
        "currency": "usd"
      },
      "employer_taxes": {
        "amount": 76500,
        "currency": "usd"
      },
      "employee_taxes": {
        "amount": 120000,
        "currency": "usd"
      },
      "individual_ids": [
        "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
        "9b2e4d7f-22cc-5f7b-0d1e-994b68f23457"
      ],
      "pay_group_ids": [
        "a1b2c3d4-1111-2222-3333-444455556666"
      ],
      "pay_frequencies": [
        "bi_weekly"
      ]
    }
  ]
}