v4

latestOpenAPI 3.0.02026-07-314441026.8 MB
Pay Splits

Create a pay split

post/pay_splits

Request body

employee_idstring

Must be present when contractor_id is either empty or not set.

contractor_idstring

Must be present when employee_id is either empty or not set.

type'amount' | 'percentage' required

The split strategy. amount sends fixed dollar amounts in priority order with the last configured Bank Account receiving the remaining balance. percentage distributes by percentage; percentage must total 100% across all accounts.

titlestring nullable

A label for this pay split configuration.

is_defaultboolean

Whether this is the default pay split for the Employee or Contractor.

priority_1_bank_account_idstring required
priority_1_amountnumber required

The amount or percentage allocated to the first priority Bank Account.

priority_2_bank_account_idstring required
priority_2_amountnumber

The amount or percentage for the second priority Bank Account. For amount-type splits, set to null if this is the last account (receives the remainder).

priority_3_bank_account_idstring
priority_3_amountnumber

The amount or percentage for the third priority Bank Account.

priority_4_bank_account_idstring
priority_4_amountnumber

The amount or percentage for the fourth priority Bank Account.

priority_5_bank_account_idstring
priority_5_amountnumber

The amount or percentage for the fifth priority Bank Account.

priority_6_bank_account_idstring
priority_6_amountnumber

The amount or percentage for the sixth priority Bank Account.

priority_7_bank_account_idstring
priority_7_amountnumber

The amount or percentage for the seventh priority Bank Account.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("pay_split").