CHcheckhq

List net pay splits

Changed on

Returns a list of net pay splits.

One of employee or contractor is required.

get/net_pay_splits

Request

Query parameters

employeestring

ID of the employee whose net pay splits should be listed

contractorstring

ID of the contractor whose net pay split should be listed

limitinteger

Number of net pay splits returned per page. The maximum value is 500.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

idstring
employeestring
contractorunknown
deactivated_atunknown
deactivated_reasonunknown
is_defaultboolean

Example response

[
  {
    "id": "nps_lk218jk9082mjkjljT1c",
    "employee": "emp_zGGp6wYcxAeu1Ng8IA7v",
    "is_default": true,
    "splits": [
      {
        "bank_account": "bnk_R1UMH4Jtbjek10B9TxiX",
        "priority": 1,
        "amount": 100
      }
    ]
  }
]

Changes