Ash: spelling correction

2025-02-06T04:08:52Z

spelling correction

← Older revision		Revision as of 23:08, 5 February 2025
Line 241:		Line 241:
	:A [[Field Type: Text\|text field]] that provides the type for manual tax calculation.		:A [[Field Type: Text\|text field]] that provides the type for manual tax calculation.
	:Possible values are:		:Possible values are:
	:* '''PAYGMANUAL''': ~~Indicidates~~ this is a manual adjustment for PAYG.		:* '''PAYGMANUAL''': Indicates this is a manual adjustment for PAYG.
	:* '''ETPOMANUAL''': ~~Indicidates~~ this is a manual adjustment for PAYG on Employment Termination Payments Type O.		:* '''ETPOMANUAL''': Indicates 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.		:* '''ETPRMANUAL''': Indicates 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.		:* '''SCHEDULE5MANUAL''': Indicates this is a manual adjustment for PAYG on Schedule 5.
	:* '''SCHEDULE5STSLMANUAL''': ~~Indicidates~~ this is a manual adjustment for STSL Component on Schedule 5.		:* '''SCHEDULE5STSLMANUAL''': Indicates this is a manual adjustment for STSL Component on Schedule 5.

	;LiabilityAccount		;LiabilityAccount

Nic at 04:48, 14 December 2023

2023-12-14T04:48:34Z

← Older revision		Revision as of 23:48, 13 December 2023
Line 19:		Line 19:
	== Fields ==		== Fields ==

	The following fields are available for the ~~Payslips~~ endpoint.		The following fields are available for the GetPayslip endpoint.

	;PayslipID		;PayslipID

Nic at 23:42, 17 January 2022

2022-01-17T23:42:35Z

← Older revision		Revision as of 18:42, 17 January 2022
Line 193:		Line 193:
	: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: Created page with "== Overview == The Xero '''GetPayslip''' endpoint provides the fields for a specific pay slip. It is a function..."

2022-01-17T23:41:53Z

Created page with "== Overview == The Xero '''GetPayslip''' endpoint provides the fields for a specific pay slip. It is a function..."

New page

== Overview ==

The Xero '''GetPayslip''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the fields for a specific pay slip.

It is a [[Function Endpoints|function]] that accepts a series of parameters.

You may also use the [[Xero Payroll (Australia) Endpoint: Payslips|Payslips]] which provides similar data but for all known pay runs.

== Parameters ==

The GetPayslip is a [[Function Endpoints|function]] that accepts the following parameters.

;PayslipID
:A [[Field Type: GUID|guid field]] that determines the payslip for which to retrieve data.
:This field is mandatory.

== 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) Endpoint: 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]]
:[[Xero Payroll (Australia) Endpoint: Payslips|Payslips]]

== Related Topics ==

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

Xero Payroll (Australia) Endpoint: GetPayslip - Revision history

Ash: spelling correction

Nic at 04:48, 14 December 2023

Nic at 23:42, 17 January 2022

Nic: Created page with "== Overview == The Xero '''GetPayslip''' endpoint provides the fields for a specific pay slip. It is a function..."