Xero Payroll (New Zealand) Endpoint: EmployeesPaymentMethods

From OdataLink
Jump to navigation Jump to search

Overview

The Xero EmployeesPaymentMethods endpoint provides the list of payment methods for employees.


Fields

The following fields are available for the EmployeesPaymentMethods endpoint.

employeeID
A guid field that provides the id of the linked employee.
bankAccounts
A table field that provides bank account details.
See BankAccounts Fields for more information.


BankAccounts Fields

The BankAccounts Fields include the following sub fields.

accountNumber
A text field that provides the bank account number of the employee.
accountName
A text field that provides the bank account name of the employee.
sortCode
A text field that provides the bank account sort code.
particulars
A text field that provides the particulars text that will appear on statements.
code
A text field that provides the code that will appear on statements.
reference
A text field that provides the text that will appear on statements.
calculationType
A text field that indicates the calculation type.
Possible values are:
  • FixedAmount: Indicates payment will be up to a specific amount.
  • Balance: Indicates payment any remainder or balance will be paid to this account.
dollarAmount
A decimal field that provides a fixed amount that will be applied to this bank account first.
Only applicable if calculationType is set to FixedAmount.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

None


Related Endpoints

Employees


Related Topics

Xero Payroll (New Zealand) Models
Xero Payroll (New Zealand) Endpoints