curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/pay_splits \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"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>"
}
}
],
"links": {
"first": "/pay_splits?employee_id=<id>&page=1",
"last": "/pay_splits?employee_id=<id>&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}List pay splits
curl --request GET \
--url https://sandbox.nmbr.co/services/payroll/pay_splits \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"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>"
}
}
],
"links": {
"first": "/pay_splits?employee_id=<id>&page=1",
"last": "/pay_splits?employee_id=<id>&page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1,
"has_more": false
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The employee_id field is required when contractor_id is not present.
The contractor_id field is required when employee_id is not present.
contractor, employee Response
OK
The type of the object in Nmbr ("list").
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("pay_split").
- Default
- With employee expanded
- With contractor expanded
Hide child attributes
Hide child attributes
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.
amount, percentage A label for this pay split configuration.
255Whether this is the default pay split for the Employee or Contractor.
The first priority Bank Account.
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("bank_account").
Hide child attributes
Hide child attributes
The Business Entity that owns this bank account. Present only for Business Entity bank accounts.
The 3-digit bank institution number.
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.
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.
The 5-digit bank transit number.
The address of the branch matching the institution and transit numbers, or null if the pair is not recognized.
The last 3 digits of the bank account number.
Whether this is the primary bank account for its owner.
Whether this bank account can be deleted.
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.
Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.
The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.
255The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.
255The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.
255The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.
The signed PAD agreement file. Only present for Business Entity bank accounts.
The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.
The amount or percentage allocated to the first priority Bank Account.
The second priority Bank Account.
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("bank_account").
Hide child attributes
Hide child attributes
The Business Entity that owns this bank account. Present only for Business Entity bank accounts.
The 3-digit bank institution number.
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.
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.
The 5-digit bank transit number.
The address of the branch matching the institution and transit numbers, or null if the pair is not recognized.
The last 3 digits of the bank account number.
Whether this is the primary bank account for its owner.
Whether this bank account can be deleted.
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.
Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.
The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.
255The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.
255The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.
255The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.
The signed PAD agreement file. Only present for Business Entity bank accounts.
The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.
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).
The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.