The net pay split object

See the net pay split guide for more information.

{
  "id": "nps_lk218jk9082mjkjljT1c",
  "employee": "emp_zGGp6wYcxAeu1Ng8IA7v",
  "contractor": null,
  "deactivated_at": null,
  "deactivated_reason": null,
  "is_default": true,
  "splits": [
    {
      "bank_account": "bnk_R1UMH4Jtbjek10B9TxiX",
      "priority": 1,
      "amount": "100.0",
      "percentage": null,
    },
    {
      "bank_account": "bnk_zGGp6wYcxAeu1Ng8IA7v",
      "priority": 2,
      "amount": null,
      "percentage": null,
    }
  ]
}

Attribute	Description
id string	Unique identifier for the net pay split.
employee string	ID of the employee that the net pay split relates to.
contractor string	ID of the contractor that the net pay split relates to.
deactivated_at datetime	Datetime at which the net pay split was deactivated.
deactivated_reason string	Reason due to which the net pay split was deactivated. `null` if not deactivated. `bank_account_disabled` or `bank_account_deleted` if deactivated.
is_default boolean	If `true`, this net pay split object is set as the default and active net pay split for a worker. Defaults to `false`.
splits array of objects	Prioritized list of bank accounts and the maximum amounts to be paid to each account.

Objects in the splits array:

Attribute	Description
bank_account string	ID of the Bank Account the net pay will be sent to.
priority integer	The priority of the net pay split with `1` being the highest priority and `7` being the lowest. Splits in the array should have consecutive integer priorities, starting from 1 (for example, 3 split objects with priorities 1, 2, and 3).
amount string	The maximum amount of dollars (and cents) this account should receive per paycheck. Note that on API versions `2023-04-04` and beyond, this field is optional. The value for this field can be omitted for the lowest priority account in the array. For the other accounts specified, one of `amount` or `percentage` must be provided to create a split.
percentage string	The percent of net pay this account should receive per paycheck. One of `percentage` or `amount` must be provided to create a split, except for the lowest priority account in the array. Note this field is only available on API versions `2023-04-04` and beyond (more info here).