v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List net pay splits

Returns a list of net pay splits.

One of employee or contractor is required.

get/net_pay_splits

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.

Response

200

idstring

employeestring

{"stackTrail":"paths:/net_pay_splits:get:responses:200:content:application/json:schema:items:properties:contractor","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/net_pay_splits:get:responses:200:content:application/json:schema:items:properties:deactivated_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/net_pay_splits:get:responses:200:content:application/json:schema:items:properties:deactivated_reason","oasType":"schema","type":"unknown"}

is_defaultboolean

Example response

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