Pay Splits

Update a pay split

Changed on
put/pay_splits/{pay_split}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

pay_splitstring required

Request body

employee_idstring
contractor_idstring
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.

Up to 2 decimal places.

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).

Up to 2 decimal places.

priority_3_bank_account_idstring
priority_3_amountnumber

The amount or percentage for the third priority Bank Account.

Up to 2 decimal places.

priority_4_bank_account_idstring
priority_4_amountnumber

The amount or percentage for the fourth priority Bank Account.

Up to 2 decimal places.

priority_5_bank_account_idstring
priority_5_amountnumber

The amount or percentage for the fifth priority Bank Account.

Up to 2 decimal places.

priority_6_bank_account_idstring
priority_6_amountnumber

The amount or percentage for the sixth priority Bank Account.

Up to 2 decimal places.

priority_7_bank_account_idstring
priority_7_amountnumber

The amount or percentage for the seventh priority Bank Account.

Up to 2 decimal places.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status