Xero Payroll (Australia) Endpoint: Payslips - Revision history

Nic at 23:43, 17 January 2022

2022-01-17T23:43:48Z

← Older revision		Revision as of 18:43, 17 January 2022
Line 5:		Line 5:
	As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.		As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

	Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required.		Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required. The [[Xero Payroll (Australia) Endpoint: GetPayslip\|GetPayslip]] endpoint is easier to optimise.

	To make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		To make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].
Line 263:		Line 263:
	:[[Xero Payroll (Australia) Endpoint: Employees\|Employees]]		:[[Xero Payroll (Australia) Endpoint: Employees\|Employees]]
	:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded\|EmployeesExpanded]]		:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded\|EmployeesExpanded]]
			:[[Xero Payroll (Australia) Endpoint: GetPayslip\|GetPayslip]]
	:[[Xero Payroll (Australia) Endpoint: PayItems\|PayItems]]		:[[Xero Payroll (Australia) Endpoint: PayItems\|PayItems]]
	:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes\|PayItemsDeductionTypes]]		:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes\|PayItemsDeductionTypes]]

Nic at 23:42, 17 January 2022

2022-01-17T23:42:26Z

← Older revision		Revision as of 18:42, 17 January 2022
Line 186:		Line 186:
	:Possible values are:		:Possible values are:
	:* '''SGC''': Indicates this is a mandatory contribution.		:* '''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		:* '''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		:* '''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		:* '''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution

	;CalculationType		;CalculationType

Nic at 04:31, 5 October 2021

2021-10-05T04:31:33Z

← Older revision		Revision as of 23:31, 4 October 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints\|endpoint]] provides the list of payslips.		The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints\|endpoint]] provides the list of payslips. You can join data from this endpoint with [[Xero Payroll (Australia) Endpoint: PayRunsExpanded\|PayRunsExpanded]] to access additional information belonging to the Pay Run.

	As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.		As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

Nic at 00:59, 23 September 2021

2021-09-23T00:59:04Z

← Older revision		Revision as of 19:59, 22 September 2021
Line 7:		Line 7:
	Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required.		Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required.

	~~Note that to~~ make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		To make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].

Nic at 00:57, 23 September 2021

2021-09-23T00:57:20Z

← Older revision		Revision as of 19:57, 22 September 2021
Line 2:		Line 2:

	The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints\|endpoint]] provides the list of payslips.		The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints\|endpoint]] provides the list of payslips.

			As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

			Note that this endpoint is more performance heavy as it will need to query each detailed pay run. You should only integrate with this endpoint if required.

	Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].

	As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

Nic at 00:48, 23 September 2021

2021-09-23T00:48:30Z

← Older revision		Revision as of 19:48, 22 September 2021
Line 42:		Line 42:

	;TimesheetEarningsLines		;TimesheetEarningsLines
	:A [[Field Type: Table\|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (Australia) ~~Endpoints~~: Timesheets\|timesheets]].		:A [[Field Type: Table\|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (Australia) Endpoint: Timesheets\|timesheets]].
	:See [[#TimesheetEarningsLines Fields\|TimesheetEarningsLines Fields]] for more information.		:See [[#TimesheetEarningsLines Fields\|TimesheetEarningsLines Fields]] for more information.

Nic at 00:46, 23 September 2021

2021-09-23T00:46:24Z

← Older revision		Revision as of 19:46, 22 September 2021
Line 5:		Line 5:
	Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].

	As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.		As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

Nic at 00:46, 23 September 2021

2021-09-23T00:46:05Z

← Older revision		Revision as of 19:46, 22 September 2021
Line 5:		Line 5:
	Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].

	As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[~~Models\|~~model's]] '''Default Start Date''' and '''Default End Date'''.		As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[model's]] '''Default Start Date''' and '''Default End Date'''. See [[Editing a model's details]] for more information.

Nic at 00:44, 23 September 2021

2021-09-23T00:44:32Z

← Older revision		Revision as of 19:44, 22 September 2021
Line 4:		Line 4:

	Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].		Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models\|endpoints belonging to a Xero Accounting Model]].

			As this endpoint cannot be filtered, it is optimised to pull payslips based on the [[Models\|model's]] '''Default Start Date''' and '''Default End Date'''.

Nic: Created page with "== Overview == The Xero '''Payslips''' endpoint provides the list of payslips. Note that to make full use of the data in this endpoint..."

2021-09-23T00:43:30Z

Created page with "== Overview == The Xero '''Payslips''' endpoint provides the list of payslips. Note that to make full use of the data in this endpoint..."

New page

== Overview ==

The Xero '''Payslips''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of payslips.

Note that to make full use of the data in this endpoint may require using [[Xero Accounting Models|endpoints belonging to a Xero Accounting Model]].

== Fields ==

The following fields are available for the Payslips endpoint.

;PayslipID
:A [[Field Type: GUID|guid field]] that provides the id of the payslip.

;EmployeeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: Employees|employee id]] associated with the payslip.

;FirstName
:A [[Field Type: Text|text field]] that provides the first name of the employee.

;LastName
:A [[Field Type: Text|text field]] that provides the last name of the employee.

;LastEdited
:A [[Field Type: DateTimeOffset|date time field]] that provides the last date this payslip was edited.

;Tax
:A [[Field Type: Decimal|decimal field]] that provides the total tax amount of this payslip.

;NetPay
:A [[Field Type: Decimal|decimal field]] that provides the net pay amount of this payslip.

;EarningsLines
:A [[Field Type: Table|table field]] that provides the earnings lines of the payslip. These represent earnigns recorded as default pay.
:See [[#EarningsLines Fields|EarningsLines Fields]] for more information.

;LeaveEarningsLines
:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings paid from accrued leave.
:See [[#LeaveEarningsLines Fields|LeaveEarningsLines Fields]] for more information.

;TimesheetEarningsLines
:A [[Field Type: Table|table field]] that provides the leave earnings lines of the payslip. These represent earnings captured from [[Xero Payroll (Australia) Endpoints: Timesheets|timesheets]].
:See [[#TimesheetEarningsLines Fields|TimesheetEarningsLines Fields]] for more information.

;DeductionLines
:A [[Field Type: Table|table field]] that provides the deduction lines of the payslip.
:See [[#DeductionLines Fields|DeductionLines Fields]] for more information.

;LeaveAccrualLines
:A [[Field Type: Table|table field]] that provides the leave accrual lines of the payslip.
:See [[#LeaveAccrualLines Fields|LeaveAccrualLines Fields]] for more information.

;ReimbursementLines
:A [[Field Type: Table|table field]] that provides the reimbursement lines of the payslip.
:See [[#ReimbursementLines Fields|ReimbursementLines Fields]] for more information.

;SuperannuationLines
:A [[Field Type: Table|table field]] that provides the superannuation lines of the payslip.
:See [[#SuperannuationLines Fields|SuperannuationLines Fields]] for more information.

;TaxLines
:A [[Field Type: Table|table field]] that provides the tax lines of the payslip.
:See [[#TaxLines Fields|TaxLines Fields]] for more information.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.

== EarningsLines Fields ==

The [[#Fields|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 payslip line.

;RatePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the rate per unit of this payslip line.

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

;FixedAmount
:A [[Field Type: Decimal|decimal field]] that provides the fixed amount of this payslip line.
:This only applies to certain PayItemsEarningsRates.

;LumpSumETaxYear
:A [[Field Type: Decimal|decimal field]] that provides the lump sum amount of this payslip line.
:This only applies to certain PayItemsEarningsRates.

== LeaveEarningsLines Fields ==

The [[#Fields|LeaveEarningsLines 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 payslip line.

;RatePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the rate per unit of this payslip line.

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

== TimesheetEarningsLines Fields ==

The [[#Fields|TimesheetEarningsLines 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 payslip line.

;RatePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the rate per unit of this payslip line.

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

== DeductionLines Fields ==

The [[#Fields|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 payslip 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 slip line.

== LeaveAccrualLines Fields ==

The [[#Fields|LeaveAccrualLines 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 payslip line.

;NumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units applicable for this payslip line.

;AutoCalculate
:A [[Field Type: Boolean|true/false field]] that indicates if this payslip line was automatically calculated.

== ReimbursementLines Fields ==

The [[#Fields|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 payslip line.

;Description
:A [[Field Type: Text|text field]] that provides the description for this payslip line.

;ExpenseAccount
:A [[Field Type: Text|text field]] that provides the expense account code for this payslip line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the [[Xero Accounting Models|Xero Accounting Model]].

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this payslip line.

== SuperannuationLines Fields ==

The [[#Fields|SuperannuationLines 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.

;PaymentDateForThisPeriod
:A [[Field Type: Date|date field]] that provides the payment date for this pay slip.

;ExpenseAccountCode
:A [[Field Type: Text|text field]] that provides the expense account code for this payslip 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 payslip 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.

== TaxLines Fields ==

The [[#Fields|TaxLines Fields]] include the following sub fields.

;PayslipTaxLineID
:A [[Field Type: GUID|guid field]] that provides the id of the pay slip tax line.

;TaxTypeName
:A [[Field Type: Text|text field]] that provides the name of the tax.

;Description
:A [[Field Type: Text|text field]] that provides the description of the tax.

;ManualTaxType
:A [[Field Type: Text|text field]] that provides the type for manual tax calculation.
:Possible values are:
:* '''PAYGMANUAL''': Indicidates this is a manual adjustment for PAYG.
:* '''ETPOMANUAL''': Indicidates this is a manual adjustment for PAYG on Employment Termination Payments Type O.
:* '''ETPRMANUAL''': Indicidates this is a manual adjustment for PAYG on Employment Termination Payments Type R.
:* '''SCHEDULE5MANUAL''': Indicidates this is a manual adjustment for PAYG on Schedule 5.
:* '''SCHEDULE5STSLMANUAL''': Indicidates this is a manual adjustment for STSL Component on Schedule 5.

;LiabilityAccount
:A [[Field Type: Text|text field]] that provides the liability account code for this payslip line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the [[Xero Accounting Models|Xero Accounting Model]].

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollau/payslip Xero API].

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Payroll (Australia) Endpoint: Employees|Employees]]
:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
:[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]
:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|PayItemsReimbursementTypes]]
:[[Xero Payroll (Australia) Endpoint: PayRuns|PayRuns]]
:[[Xero Payroll (Australia) Endpoint: PayRunsExpanded|PayRunsExpanded]]

== Related Topics ==

:[[Xero Payroll (Australia) Models]]
:[[Xero Payroll (Australia) Endpoints]]