v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Create a net pay split

Creates a net pay split.

One of employee or contractor is required.

post/net_pay_splits

Request body

employeestring

ID of the employee that the net pay split relates to.

contractorstring

ID of the contractor that the net pay split relates to.

is_defaultboolean

Response

200

idstring
employeestring
{"stackTrail":"paths:/net_pay_splits:post:responses:200:content:application/json:schema:properties:contractor","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/net_pay_splits:post:responses:200:content:application/json:schema:properties:deactivated_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/net_pay_splits:post:responses:200:content:application/json:schema: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
    }
  ]
}