OdataLink

Difference between revisions of "Xero Payroll (Australia) Endpoint: EmployeesExpanded"

Xero Payroll (Australia) Endpoint: EmployeesExpanded (view source)

Revision as of 22:20, 22 September 2021

10,473 bytes added ,  22:20, 22 September 2021
no edit summary
(Created page with "== Overview == The Xero '''EmployeesExpanded''' endpoint provides the list of employees. This endpoint provides all detailed informati...")
 
Line 274: Line 274:


;ReimbursementLines
;ReimbursementLines
:A [[Field Type: Table|table field]] that provides reimbusrement lines for this emplopyee.
:A [[Field Type: Table|table field]] that provides reimbursement lines for this emplopyee.
:See [[#PayTemplate.ReimbursementLines Fields|PayTemplate.ReimbursementLines Fields]] for more information.
:See [[#PayTemplate.ReimbursementLines Fields|PayTemplate.ReimbursementLines Fields]] for more information.


Line 285: Line 285:


The [[#PayTemplate Fields|PayTemplate.EarningsLines Fields]] include the following sub fields.
The [[#PayTemplate Fields|PayTemplate.EarningsLines Fields]] include the following sub fields.
;EarningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|earnings rate id]] associated with this pay template line.
;CalculationType
:A [[Field Type: Text|text field]] that indicates the calculation type of this earnings line.
:Possible values are:
:* '''USEEARNINGSRATE''': Indicates it uses the rate per unit recorded for the earnings rate under Settings
:* '''ENTEREARNINGSRATE''': Indicates it uses the rate per unit is be added manually to the earnings line
:* '''ANNUALSALARY''': Indicates it uses the employee receives a fixed annual salary amount.
;AnnualSalary
:A [[Field Type: Decimal|decimal field]] that provides the provides the annual salary of the employee.
;NumberOfUnitsPerWeek
:A [[Field Type: Decimal|decimal field]] that provides the number of hours worked per week for this earnings rate.
;RatePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the hourly rate for this earning rate.
;NormalNumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the normal number of hours worked.




Line 290: Line 312:


The [[#PayTemplate Fields|PayTemplate.DeductionLines Fields]] include the following sub fields.
The [[#PayTemplate Fields|PayTemplate.DeductionLines Fields]] include the following sub fields.
;DeductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|pay item deduction type id]] associated with this pay template line.
;CalculationType
:A [[Field Type: Text|text field]] that provides the calculation type.
:Possible values are:
:* '''FIXEDAMOUNT'''
:* '''PRETAX'''
:* '''POSTTAX'''
;Percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate if applicable.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this pay template line.




Line 295: Line 333:


The [[#PayTemplate Fields|PayTemplate.SuperLines Fields]] include the following sub fields.
The [[#PayTemplate Fields|PayTemplate.SuperLines Fields]] include the following sub fields.
;SuperMembershipID
:A [[Field Type: GUID|guid field]] that provides the id of the super membership fund.
;ContributionType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''SGC''': Indicates this is a mandatory contribution.
'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution
;CalculationType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''FIXEDAMOUNT''': Indicates the super contribution is a fixed amount.
:* '''PERCENTAGEOFEARNINGS''': Indicates the super contribution is a calculated as a percentage of earnings.
:* '''STATUTORY''': Indicates the super contribution is a calculated as the statutory rate.
;ExpenseAccountCode
:A [[Field Type: Text|text field]] that provides the expense account code for this pay template line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the  [[Xero Accounting Models|Xero Accounting Model]].
;LiabilityAccountCode
:A [[Field Type: Text|text field]] that provides the liability account code for this pay template line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the  [[Xero Accounting Models|Xero Accounting Model]].
;MinimumMonthlyEarnings
:A [[Field Type: Decimal|decimal field]] that provides the minimum monthly earnings required to quality.
;Percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate used to calculate the amount (if applicable).
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.




Line 300: Line 373:


The [[#PayTemplate Fields|PayTemplate.ReimbursementLines Fields]] include the following sub fields.
The [[#PayTemplate Fields|PayTemplate.ReimbursementLines Fields]] include the following sub fields.
;ReimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|pay item reimbursement type id]] associated with this pay template line.
;Description
:A [[Field Type: Text|text field]] that provides the description for this pay template line.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this pay template line.




Line 306: Line 388:
The [[#PayTemplate Fields|PayTemplate.LeaveLines Fields]] include the following sub fields.
The [[#PayTemplate Fields|PayTemplate.LeaveLines Fields]] include the following sub fields.


;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|pay item leave type id]] associated with this pay template line.
;Description
:A [[Field Type: Text|text field]] that provides calculation method.
:Possible values are:
:* '''NOCALCULATIONREQUIRED''': Indicates no leave will be accrued. Manual leave accruals can be done on the payslip if required.
:* '''FIXEDAMOUNTEACHPERIOD''': Indicates leave accrues a fixed amount of leave each pay period based on annual entitlement.
:* '''ENTERRATEINPAYTEMPLATE''': Indicates leave will be entered manually.
:* '''BASEDONORDINARYEARNINGS''': Indicates leave will accrue a relative amount of leave on the number of hours an employee works in the pay period.


;AnnualNumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the total number of units applicable per year for this pay template line.


;FullTimeNumberOfUnitsPerPeriod
:A [[Field Type: Decimal|decimal field]] that provides the number of units applicable per pay period for this pay template line.


;NumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units for this pay template line.
;EntitlementFinalPayPayoutType
:A [[Field Type: Text|text field]] that indicates how leave balances will be paid out on termination.
:Possible values are:
:* '''NOTPAIDOUT'''
:* '''PAIDOUT'''
;EmploymentTerminationPaymentType
:A [[Field Type: Text|text field]] that indicates how leave balances will be paid out on termination.
:This field will be set to '''O'''' if '''EntitlementFinalPayPayoutType''' is set to '''PAIDOUT'''
;IncludeSuperannuationGuaranteeContribution
:A [[Field Type: Boolean|true/false field]] that indicates if ETP leave earnings are subject to superannuation guarantee contribution (SGC).




Line 314: Line 425:


The [[#Fields|OpeningBalances Fields]] include the following sub fields.
The [[#Fields|OpeningBalances Fields]] include the following sub fields.
;OpeningBalanceDate
:A [[Field Type: Date|date field]] that provides the as-at-date used to calculate the opening balances.
;Tax
:A [[Field Type: Decimal|decimal field]] that provides the opening balance tax amount.
;EarningsLines
:A [[Field Type: Table|table field]] that provides the opening balance for earning lines for this emplopyee.
:See [[#OpeningBalances.EarningsLines Fields|OpeningBalances.EarningsLines Fields]] for more information.
;DeductionLines
:A [[Field Type: Table|table field]] that provides the opening balance for deduction lines for this emplopyee.
:See [[#OpeningBalances.DeductionLines Fields|OpeningBalances.DeductionLines Fields]] for more information.
;SuperLines
:A [[Field Type: Table|table field]] that provides the opening balance for superannuation lines for this emplopyee.
:See [[#OpeningBalances.SuperLines Fields|OpeningBalances.SuperLines Fields]] for more information.
;ReimbursementLines
:A [[Field Type: Table|table field]] that provides the opening balance for reimbursement lines for this emplopyee.
:See [[#OpeningBalances.ReimbursementLines Fields|OpeningBalances.ReimbursementLines Fields]] for more information.
;LeaveLines
:A [[Field Type: Table|table field]] that provides the opening balance for leave lines for this emplopyee.
:See [[#OpeningBalances.LeaveLines Fields|OpeningBalances.LeaveLines Fields]] for more information.
== OpeningBalances.EarningsLines Fields ==
The [[#Fields|OpeningBalances.EarningsLines Fields]] include the following sub fields.
;EarningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|earnings rate id]] associated with this opening balance.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.
== OpeningBalances.DeductionLines Fields ==
The [[#Fields|OpeningBalances.DeductionLines Fields]] include the following sub fields.
;DeductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|deduction type id]] associated with this opening balance.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.
== OpeningBalances.SuperLines Fields ==
The [[#Fields|OpeningBalances.SuperLines Fields]] include the following sub fields.
;SuperMembershipID
:A [[Field Type: GUID|guid field]] that provides the super membership id associated with this opening balance.
;ContributionType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''SGC''': Indicates this is a mandatory contribution.
'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.
== OpeningBalances.ReimbursementLines Fields ==
The [[#Fields|OpeningBalances.ReimbursementLines Fields]] include the following sub fields.
;ReimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|reimbursement type id]] associated with this opening balance.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.
== OpeningBalances.LeaveLines Fields ==
The [[#Fields|OpeningBalances.LeaveLines Fields]] include the following sub fields.
;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|leave type id]] associated with this opening balance.
;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.




Line 320: Line 518:
The [[#Fields|LeaveBalances Fields]] include the following sub fields.
The [[#Fields|LeaveBalances Fields]] include the following sub fields.


;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|leave type id]] associated with this balance.


;LeaveName
:A [[Field Type: Text|text field]] that provides the name of the pay item leave.


;TypeOfUnits
:A [[Field Type: Text|text field]] that provides the type of units of the pay item leave.


 
;NumberOfUnits
 
:A [[Field Type: Decimal|decimal field]] that provides the number of units accrued.




Line 341: Line 545:
:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
:[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]
:[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]
:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|PayItemsReimbursementTypes]]
:[[Xero Payroll (Australia) Endpoint: PayrollCalendars|PayrollCalendars]]
:[[Xero Payroll (Australia) Endpoint: PayrollCalendars|PayrollCalendars]]
 
:[[Xero Payroll (Australia) Endpoint: SuperFunds|SuperFunds]]




Nic
Write, Bureaucrats, Administrators
3,301

edits

Retrieved from "https://help.odatalink.com/index.php?title=Special:MobileDiff/2343"