Retrieve a pay split

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/pay_splits/{pay_split} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<id>",
  "object": "pay_split",
  "data": {
    "employee": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "type": "percentage",
    "title": null,
    "is_default": false,
    "priority_1_bank_account": {
      "id": "<id>",
      "object": "bank_account",
      "data": {
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "institution_number": "320",
        "institution_name": "President's Choice Bank",
        "institution_name_translations": {
          "en": "President's Choice Bank",
          "fr": "Banque le Choix du Président"
        },
        "institution_name_translated": "President's Choice Bank",
        "transit_number": "02002",
        "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
        "account_number_last_3": "916",
        "is_primary": false,
        "is_deletable": false,
        "warnings": {
          "object": "list",
          "data": []
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/bank_accounts/<id>"
      }
    },
    "priority_1_amount": 50,
    "priority_2_bank_account": {
      "id": "<id>",
      "object": "bank_account",
      "data": {
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "institution_number": "320",
        "institution_name": "President's Choice Bank",
        "institution_name_translations": {
          "en": "President's Choice Bank",
          "fr": "Banque le Choix du Président"
        },
        "institution_name_translated": "President's Choice Bank",
        "transit_number": "02002",
        "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
        "account_number_last_3": "916",
        "is_primary": false,
        "is_deletable": false,
        "warnings": {
          "object": "list",
          "data": []
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/bank_accounts/<id>"
      }
    },
    "priority_2_amount": 50,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/pay_splits/<id>"
  }
}

GET

pay_splits

{pay_split}

Retrieve a pay split

curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/pay_splits/{pay_split} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<id>",
  "object": "pay_split",
  "data": {
    "employee": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "type": "percentage",
    "title": null,
    "is_default": false,
    "priority_1_bank_account": {
      "id": "<id>",
      "object": "bank_account",
      "data": {
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "institution_number": "320",
        "institution_name": "President's Choice Bank",
        "institution_name_translations": {
          "en": "President's Choice Bank",
          "fr": "Banque le Choix du Président"
        },
        "institution_name_translated": "President's Choice Bank",
        "transit_number": "02002",
        "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
        "account_number_last_3": "916",
        "is_primary": false,
        "is_deletable": false,
        "warnings": {
          "object": "list",
          "data": []
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/bank_accounts/<id>"
      }
    },
    "priority_1_amount": 50,
    "priority_2_bank_account": {
      "id": "<id>",
      "object": "bank_account",
      "data": {
        "employee": {
          "id": "<id>",
          "object": "employee",
          "links": {
            "self": "/employees/<id>"
          }
        },
        "institution_number": "320",
        "institution_name": "President's Choice Bank",
        "institution_name_translations": {
          "en": "President's Choice Bank",
          "fr": "Banque le Choix du Président"
        },
        "institution_name_translated": "President's Choice Bank",
        "transit_number": "02002",
        "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
        "account_number_last_3": "916",
        "is_primary": false,
        "is_deletable": false,
        "warnings": {
          "object": "list",
          "data": []
        },
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/bank_accounts/<id>"
      }
    },
    "priority_2_amount": 50,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/pay_splits/<id>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pay_split

string

required

Query Parameters

expand

enum<string>[]

Available options:

contractor,

employee

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Default · object

Default
With employee expanded
With contractor expanded

Hide child attributes

data.employee

object

The Employee who owns this pay split. Present only for Employee pay splits.

Hide child attributes

data.employee.id

string

read-only

The unique identifier of the object in Nmbr.

data.employee.object

string

read-only

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

data.type

enum<string>

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.

Available options:

amount,

percentage

data.title

string | null

A label for this pay split configuration.

Maximum string length: 255

data.is_default

boolean

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

data.priority_1_bank_account

object

The first priority Bank Account.

Hide child attributes

data.priority_1_bank_account.id

string

read-only

The unique identifier of the object in Nmbr.

data.priority_1_bank_account.object

string

read-only

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

data.priority_1_bank_account.data

Bank Account · object

Hide child attributes

data.priority_1_bank_account.data.business_entity

object

The Business Entity that owns this bank account. Present only for Business Entity bank accounts.

Hide child attributes

data.priority_1_bank_account.data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.priority_1_bank_account.data.business_entity.object

string

read-only

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

data.priority_1_bank_account.data.institution_number

string

The 3-digit bank institution number.

data.priority_1_bank_account.data.institution_name

string | null

The name of the banking institution matching the institution number, or null if the number is not recognized. Always the English name; see institution_name_translated for the value in the request's locale.

data.priority_1_bank_account.data.institution_name_translations

object

Hide child attributes

data.priority_1_bank_account.data.institution_name_translations.en

string | null

data.priority_1_bank_account.data.institution_name_translations.fr

string | null

data.priority_1_bank_account.data.institution_name_translated

string

read-only

The translation of the institution_name property for the request locale. Computed using the values in institution_name and institution_name_translations and the value of the request's Accept-Language header.

data.priority_1_bank_account.data.transit_number

string

The 5-digit bank transit number.

data.priority_1_bank_account.data.transit_address

string | null

The address of the branch matching the institution and transit numbers, or null if the pair is not recognized.

data.priority_1_bank_account.data.account_number_last_3

string | null

The last 3 digits of the bank account number.

data.priority_1_bank_account.data.is_primary

boolean

Whether this is the primary bank account for its owner.

data.priority_1_bank_account.data.is_deletable

boolean

Whether this bank account can be deleted.

data.priority_1_bank_account.data.warnings

object

A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.

Hide child attributes

data.priority_1_bank_account.data.warnings.object

string | null

data.priority_1_bank_account.data.warnings.data

object

data.priority_1_bank_account.data.is_pad_signed

boolean

Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.

data.priority_1_bank_account.data.pad_signer_name

string | null

The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_1_bank_account.data.pad_signer_email

string | null

The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_1_bank_account.data.pad_signer_title

string | null

The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_1_bank_account.data.pad_signed_at

string<dateTime> | null

read-only

The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.

data.priority_1_bank_account.data.pad_file

any

The signed PAD agreement file. Only present for Business Entity bank accounts.

data.priority_1_bank_account.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.priority_1_bank_account.data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

data.priority_1_amount

number<decimal>

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

data.priority_2_bank_account

object

The second priority Bank Account.

Hide child attributes

data.priority_2_bank_account.id

string

read-only

The unique identifier of the object in Nmbr.

data.priority_2_bank_account.object

string

read-only

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

data.priority_2_bank_account.data

Bank Account · object

Hide child attributes

data.priority_2_bank_account.data.business_entity

object

The Business Entity that owns this bank account. Present only for Business Entity bank accounts.

Hide child attributes

data.priority_2_bank_account.data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.priority_2_bank_account.data.business_entity.object

string

read-only

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

data.priority_2_bank_account.data.institution_number

string

The 3-digit bank institution number.

data.priority_2_bank_account.data.institution_name

string | null

data.priority_2_bank_account.data.institution_name_translations

object

Hide child attributes

data.priority_2_bank_account.data.institution_name_translations.en

string | null

data.priority_2_bank_account.data.institution_name_translations.fr

string | null

data.priority_2_bank_account.data.institution_name_translated

string

read-only

data.priority_2_bank_account.data.transit_number

string

The 5-digit bank transit number.

data.priority_2_bank_account.data.transit_address

string | null

The address of the branch matching the institution and transit numbers, or null if the pair is not recognized.

data.priority_2_bank_account.data.account_number_last_3

string | null

The last 3 digits of the bank account number.

data.priority_2_bank_account.data.is_primary

boolean

Whether this is the primary bank account for its owner.

data.priority_2_bank_account.data.is_deletable

boolean

Whether this bank account can be deleted.

data.priority_2_bank_account.data.warnings

object

A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.

Hide child attributes

data.priority_2_bank_account.data.warnings.object

string | null

data.priority_2_bank_account.data.warnings.data

object

data.priority_2_bank_account.data.is_pad_signed

boolean

Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.

data.priority_2_bank_account.data.pad_signer_name

string | null

The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_2_bank_account.data.pad_signer_email

string | null

The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_2_bank_account.data.pad_signer_title

string | null

The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.priority_2_bank_account.data.pad_signed_at

string<dateTime> | null

read-only

The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.

data.priority_2_bank_account.data.pad_file

any

The signed PAD agreement file. Only present for Business Entity bank accounts.

data.priority_2_bank_account.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.priority_2_bank_account.data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

data.priority_2_amount

number<decimal> | null

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

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Create a pay split Update a pay split

⌘I