Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions docs/v1/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2104,6 +2104,11 @@
"type" : "string",
"description" : "Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)"
},
"TaxNumberType" : {
"type" : "string",
"description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers",
"enum" : [ "SSN", "EIN", "ITIN", "ATIN" ]
},
"AccountsReceivableTaxType" : {
"type" : "string",
"description" : "The tax type from TaxRates"
Expand Down
193 changes: 0 additions & 193 deletions docs/v1/payroll-nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4296,9 +4296,6 @@
<li data-group="PayrollNz" data-name="updateEmployeeTax" class="">
<a href="#api-PayrollNz-updateEmployeeTax">updateEmployeeTax</a>
</li>
<li data-group="PayrollNz" data-name="updatePayRun" class="">
<a href="#api-PayrollNz-updatePayRun">updatePayRun</a>
</li>
<li data-group="PayrollNz" data-name="updatePaySlipLineItems" class="">
<a href="#api-PayrollNz-updatePaySlipLineItems">updatePaySlipLineItems</a>
</li>
Expand Down Expand Up @@ -15022,196 +15019,6 @@ <h2>Parameters</h2>
}
},
"required" : true
}
</script>
</table>
</article>
</div>
<hr>
<div id="api-PayrollNz-updatePayRun">
<article id="api-PayrollNz-updatePayRun-0" data-group="User" data-name="updatePayRun" data-version="0">
<div class="pull-left">
<h1>updatePayRun</h1>
<p>Updates a pay run</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked"></p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/PayRuns/{PayRunID}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<!-- *****REPLACE***** comment out the other languages <li> -->
<li class=""><a href="#examples-PayrollNz-updatePayRun-0-python">Python</a></li>
</ul>
<div class="tab-content">
<!-- *****REPLACE***** comment out the other languages tab-pane -->
<div class="tab-pane" id="examples-PayrollNz-updatePayRun-0-python">
<pre class="prettyprint"><code class="language-python"># configure api_client for use with xero-python sdk client
api_client = ApiClient(
Configuration(
debug=false,
oauth2_token=OAuth2Token(
client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
),
),
pool_threads=1,
)

api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")

def accounting_update_pay_run():
api_instance = PayrollNzApi(api_client)
xero_tenant_id = 'xeroTenantId_example'
pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
idempotency_key = 'KEY_VALUE'
start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')

pay_run_calendar = PayRunCalendar(
calendar_type = calendar_type.WEEKLY,
period_start_date = start_date,
payment_date = payment_date)

try:
api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, payRun, idempotency_key)
print(api_response)
except AccountingBadRequestException as e:
print("Exception when calling PayrollNzApi->updatePayRun: %s\n" % e)</code></pre>
</div>
</div>
<h2>Scopes</h2>
<table>

<tr>
<td>payroll.payruns</td>
<td>Grant read-write access to payroll payruns</td>
</tr>

</table>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">PayRunID<span style="color:red;">*</span></td>
<td>


<div id="d2e199_updatePayRun_payRunID">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
UUID
</span>
<span class="format">
(uuid)
</span>

<div class="inner description marked">
Identifier for the pay run
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

</table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">Xero-Tenant-Id<span style="color:red;">*</span></td>
<td>


<div id="d2e199_updatePayRun_xeroTenantId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>

<div class="inner description marked">
Xero identifier for Tenant
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

<tr><td style="width:150px;">Idempotency-Key</td>
<td>


<div id="d2e199_updatePayRun_idempotencyKey">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>

<div class="inner description marked">
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
</div>
</div>
</div>
</div>
</td>
</tr>

</table>
<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr>
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
<td>
<div class="json-schema-view">
<div class="primitive">
<span class="type">
PayRun
</span>
<div class="inner description marked">

</div>
</div>
<div class="inner required">
Required
</div>
</div>
<script type="application/ld+json">
{
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PayRun"
},
"example" : {
"paymentDate" : "2019-07-01"
}
}
},
"required" : true
}
</script>
</table>
Expand Down
Loading
Loading