https://help.odatalink.com/index.php?action=history&feed=atom&title=Xero_Payroll_%28New_Zealand%29_Endpoint%3A_GetPayRunXero Payroll (New Zealand) Endpoint: GetPayRun - Revision history2026-10-26T13:32:19ZRevision history for this page on the wikiMediaWiki 1.43.11https://help.odatalink.com/index.php?title=Xero_Payroll_(New_Zealand)_Endpoint:_GetPayRun&diff=2593&oldid=prevNic at 01:04, 19 January 20222022-01-19T01:04:06Z<p></p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 20:04, 18 January 2022</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l81">Line 81:</td>
<td colspan="2" class="diff-lineno">Line 81:</td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;paySlipID</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;paySlipID</div></td></tr>
<tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: <del style="font-weight: bold; text-decoration: none;">Payslips</del>|payslip id]].</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: <ins style="font-weight: bold; text-decoration: none;">PaySlips</ins>|payslip id]].</div></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;employeeID</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;employeeID</div></td></tr>
</table>Nichttps://help.odatalink.com/index.php?title=Xero_Payroll_(New_Zealand)_Endpoint:_GetPayRun&diff=2574&oldid=prevNic: Created page with "== Overview == The Xero '''GetPayRun''' endpoint provides fields for a specific pay run. It is a function tha..."2022-01-19T00:17:04Z<p>Created page with "== Overview == The Xero '''GetPayRun''' <a href="/index.php?title=Xero_Payroll_(New_Zealand)_Endpoints" title="Xero Payroll (New Zealand) Endpoints">endpoint</a> provides fields for a specific pay run. It is a <a href="/index.php?title=Function_Endpoints" title="Function Endpoints">function</a> tha..."</p>
<p><b>New page</b></p><div>== Overview ==<br />
<br />
The Xero '''GetPayRun''' [[Xero Payroll (New Zealand) Endpoints|endpoint]] provides fields for a specific pay run.<br />
<br />
It is a [[Function Endpoints|function]] that accepts a series of parameters.<br />
<br />
You may also use the [[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]] which provides similar data but for all known pay runs.<br />
<br />
<br />
== Parameters ==<br />
<br />
The GetPayRun is a [[Function Endpoints|function]] that accepts the following parameters.<br />
<br />
;PayRunID<br />
:A [[Field Type: GUID|guid field]] that determines the pay run for which to retrieve data.<br />
:This field is mandatory.<br />
<br />
<br />
== Fields ==<br />
<br />
The following fields are available for the GetPayRun endpoint.<br />
<br />
;payRunID<br />
:A [[Field Type: GUID|guid field]] that provides the id of the pay run.<br />
<br />
;payrollCalendarID<br />
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: PayrollCalendars|payroll calendar id]] of the pay run.<br />
<br />
;periodStartDate<br />
:A [[Field Type: Date|date field]] that provides the start date of the pay run.<br />
<br />
;periodEndDate<br />
:A [[Field Type: Date|date field]] that provides the end date of the pay run.<br />
<br />
;paymentDate<br />
:A [[Field Type: Date|date field]] that provides the payment date of the pay run.<br />
<br />
;postedDateTime<br />
:A [[Field Type: DateTimeOffset|datetime field]] that provides the date and time the pay run was posted.<br />
<br />
;payRunStatus<br />
:A [[Field Type: Text|text field]] that provides the status of the pay run.<br />
:Possible values are:<br />
:* '''Draft'''<br />
:* '''Posted'''<br />
<br />
;payRunType<br />
:A [[Field Type: Text|text field]] that provides the status of the pay run.<br />
:Possible values are:<br />
:* '''Scheduled''': Pay run that is using the normal pay run period.<br />
:* '''Unscheduled''': Pay run that is not using the normal pay run period.<br />
:* '''EarlierYearUpdate''': Pay run that is of Earlier Year Update.<br />
<br />
;calendarType<br />
:A [[Field Type: Text|text field]] that provides the status of the pay run.<br />
:Possible values are:<br />
:* '''Weekly'''<br />
:* '''Fortnightly'''<br />
:* '''TwiceMonthly'''<br />
:* '''Monthly'''<br />
:* '''FourWeekly'''<br />
<br />
;payslipMessage<br />
:A [[Field Type: Text|text field]] that provides the pay slip message attached to a pay run.<br />
<br />
;totalCost<br />
:A [[Field Type: Decimal|decimal field]] that provides the total costs of the pay run.<br />
<br />
;totalPay<br />
:A [[Field Type: Decimal|decimal field]] that provides the total paid amount of the pay run.<br />
<br />
;paySlips<br />
:A [[Field Type: Table|table field]] that provides the pay slips of the pay run.<br />
:See [[#PaySlips Fields|PaySlips Fields]] for more information.<br />
<br />
<br />
<br />
== PaySlips Fields ==<br />
<br />
The [[#Fields|PaySlips Fields]] include the following sub fields.<br />
<br />
;paySlipID<br />
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: Payslips|payslip id]].<br />
<br />
;employeeID<br />
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (New Zealand) Endpoint: Employees|employee id]] associated with the payslip.<br />
<br />
;firstName<br />
:A [[Field Type: Text|text field]] that provides the first name of the employee.<br />
<br />
;lastName<br />
:A [[Field Type: Text|text field]] that provides the last name of the employee.<br />
<br />
;paymentMethod<br />
:A [[Field Type: Text|text field]] that provides the way in which the pay slip was paid.<br />
<br />
;totalEarnings<br />
:A [[Field Type: Decimal|decimal field]] that provides the total earnings amount of this payslip.<br />
<br />
;grossEarnings<br />
:A [[Field Type: Decimal|decimal field]] that provides the gross earnings amount of this payslip.<br />
<br />
;totalPay<br />
:A [[Field Type: Decimal|decimal field]] that provides the net pay.<br />
<br />
;totalEmployerTaxes<br />
:A [[Field Type: Decimal|decimal field]] that provides the total employer taxes of this payslip.<br />
<br />
;totalEmployeeTaxes<br />
:A [[Field Type: Decimal|decimal field]] that provides the total employee taxes of this payslip.<br />
<br />
;totalDeductions<br />
:A [[Field Type: Decimal|decimal field]] that provides the total deductions of this payslip.<br />
<br />
;totalReimbursements<br />
:A [[Field Type: Decimal|decimal field]] that provides the total reimbursement amount of this payslip.<br />
<br />
;totalStatutoryDeductions<br />
:A [[Field Type: Decimal|decimal field]] that provides the total statutory deductions of this payslip.<br />
<br />
;totalSuperannuation<br />
:A [[Field Type: Decimal|decimal field]] that provides the total superannuations of this payslip.<br />
<br />
;bacsHash<br />
:A [[Field Type: Text|text field]] that provides the BACS service user number.<br />
<br />
;lastEdited<br />
:A [[Field Type: DateTimeOffset|date time field]] that provides the last date this payslip was edited.<br />
<br />
<br />
== Xero API ==<br />
<br />
For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollnz/payruns Xero API].<br />
<br />
<br />
== Related Fields ==<br />
<br />
:None<br />
<br />
<br />
== Related Endpoints ==<br />
<br />
:[[Xero Payroll (New Zealand) Endpoint: Employees|Employees]]<br />
:[[Xero Payroll (New Zealand) Endpoint: PayrollCalendars|PayrollCalendars]]<br />
:[[Xero Payroll (New Zealand) Endpoint: PayRuns|PayRuns]]<br />
:[[Xero Payroll (New Zealand) Endpoint: PayRunsExpanded|PayRunsExpanded]]<br />
:[[Xero Payroll (New Zealand) Endpoint: PaySlips|PaySlips]]<br />
<br />
<br />
== Related Topics ==<br />
<br />
:[[Xero Payroll (New Zealand) Models]]<br />
:[[Xero Payroll (New Zealand) Endpoints]]</div>Nic