Skip to content
Open
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions docs/v1/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4357,6 +4357,11 @@
"example" : false,
"default" : false
},
"Reference" : {
"type" : "string",
"description" : "An optional description for Overpayment",
"example" : "Ref for payment"
},
"Attachments" : {
"type" : "array",
"description" : "See Attachments",
Expand Down Expand Up @@ -6344,7 +6349,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
<li data-group="Accounting" data-name="createAccount" class="">
<a href="#api-Accounting-createAccount">createAccount</a>
Expand Down Expand Up @@ -32134,9 +32139,10 @@ <h3>Usage and SDK Samples</h3>
if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
where = 'Status=="AUTHORISED"'
order = 'Status ASC'
references = [&quot;Ref1&quot;, &quot;Ref2&quot;]

try:
api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize)
api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, references)
print(api_response)
except AccountingBadRequestException as e:
print("Exception when calling AccountingApi->getOverpayments: %s\n" % e)</code></pre>
Expand Down Expand Up @@ -32314,6 +32320,26 @@ <h2>Parameters</h2>
</div>
</div>
</td>
</tr>

<tr><td style="width:150px;">References</td>
<td>


<div id="d2e199_getOverpayments_references">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
array[String]
</span>

<div class="inner description marked">
Filter by a comma-separated list of References
</div>
</div>
</div>
</div>
</td>
</tr>

</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/appstore/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1241,7 +1241,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
<li data-group="AppStore" data-name="getSubscription" class="">
<a href="#api-AppStore-getSubscription">getSubscription</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1419,7 +1419,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
<li data-group="Asset" data-name="createAsset" class="">
<a href="#api-Asset-createAsset">createAsset</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1170,7 +1170,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
<li data-group="Files" data-name="createFileAssociation" class="">
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2716,7 +2716,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/payroll-au/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3412,7 +3412,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>
Expand Down
32 changes: 4 additions & 28 deletions docs/v1/payroll-nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1682,20 +1682,6 @@
"example" : 10.0,
"x-is-money" : true
},
"sickLeaveHoursToAccrueAnnually" : {
"type" : "number",
"description" : "Deprecated use SickLeaveToAccrueAnnually",
"format" : "double",
"example" : 100.5,
"x-is-money" : true
},
"sickLeaveMaximumHoursToAccrue" : {
"type" : "number",
"description" : "Deprecated use SickLeaveMaximumToAccrue",
"format" : "double",
"example" : 200.5,
"x-is-money" : true
},
"SickLeaveToAccrueAnnually" : {
"type" : "number",
"description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type",
Expand Down Expand Up @@ -1769,13 +1755,7 @@
"description" : "The schedule of accrual",
"enum" : [ "AnnuallyAfter6Months", "OnAnniversaryDate", "PercentageOfGrossEarnings", "NoAccruals" ]
},
"hoursAccruedAnnually" : {
"type" : "number",
"description" : "Deprecated use UnitsAccruedAnnually",
"format" : "double",
"x-is-money" : true
},
"UnitsAccruedAnnually" : {
"unitsAccruedAnnually" : {
"type" : "number",
"description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"",
"format" : "double",
Expand Down Expand Up @@ -1803,7 +1783,7 @@
},
"rateAccruedHourly" : {
"type" : "number",
"description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"",
"description" : "not supported in Payroll NZ",
"format" : "double",
"x-is-money" : true
},
Expand Down Expand Up @@ -4087,7 +4067,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
Expand Down Expand Up @@ -5390,8 +5370,6 @@ <h3>Usage and SDK Samples</h3>
include_holiday_pay = false,
holiday_pay_opening_balance = 10.5,
annual_leave_opening_balance = 25.89,
sick_leave_hours_to_accrue_annually = 100.0,
sick_leave_maximum_hours_to_accrue = 200.0,
sick_leave_opening_balance = 10.5,
sick_leave_to_accrue_annually = 100.0,
sick_leave_maximum_to_accrue = 200.0,
Expand Down Expand Up @@ -5531,7 +5509,6 @@ <h2>Parameters</h2>
"example" : {
"holidayPayOpeningBalance" : 10,
"annualLeaveOpeningBalance" : 100,
"sickLeaveHoursToAccrueAnnually" : 20,
"sickLeaveToAccrueAnnually" : 20,
"sickLeaveOpeningBalance" : 10,
"sickLeaveScheduleOfAccrual" : "OnAnniversaryDate",
Expand Down Expand Up @@ -5727,13 +5704,12 @@ <h2>Parameters</h2>
"example" : {
"leaveTypeID" : "35da97ae-05b9-427f-9a98-69157ba42cec",
"scheduleOfAccrual" : "AnnuallyAfter6Months",
"hoursAccruedAnnually" : 10,
"unitsAccruedAnnually" : 10,
"typeOfUnitsToAccrue" : "Hours",
"openingBalanceTypeOfUnits" : "Hours",
"maximumToAccrue" : 80,
"openingBalance" : 100,
"rateAccruedHourly" : 3.5
"rateAccruedHourly" : null
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/payroll-uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3700,7 +3700,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/projects/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>9.3.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>9.4.0</li>
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
<li data-group="Project" data-name="createProject" class="">
<a href="#api-Project-createProject">createProject</a>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ def read_file(filename):
keywords="xero python sdk API oAuth",
name="xero_python",
packages=find_packages(include=["xero_python", "xero_python.*"]),
version="9.3.0",
version="9.4.0",
)
2 changes: 1 addition & 1 deletion xero_python/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__author__ = """Xero Developer API"""
__email__ = "api@xero.com"
__version__ = "9.3.0"
__version__ = "9.4.0"
11 changes: 9 additions & 2 deletions xero_python/accounting/api/accounting_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 9.3.0
OpenAPI spec version: 10.1.0
"""


Expand Down Expand Up @@ -12854,6 +12854,7 @@ def get_overpayments(
page=empty,
unitdp=empty,
page_size=empty,
references=empty,
_return_http_data_only=True,
_preload_content=True,
_request_timeout=None,
Expand All @@ -12867,6 +12868,7 @@ def get_overpayments(
:param int page: e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
:param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
:param int page_size: Number of records to retrieve per page
:param list[str] references: Filter by a comma-separated list of References
:param bool _return_http_data_only: return received data only
:param bool _preload_content: load received data in models
:param bool _request_timeout: maximum wait time for response
Expand All @@ -12880,7 +12882,9 @@ def get_overpayments(
"when calling `get_overpayments`"
)

collection_formats = {}
collection_formats = {
"References": "csv",
}
path_params = {}

query_params = []
Expand All @@ -12900,6 +12904,9 @@ def get_overpayments(
if page_size is not empty:
query_params.append(("pageSize", page_size))

if references is not empty:
query_params.append(("References", references))

header_params = {
"xero-tenant-id": xero_tenant_id,
}
Expand Down
6 changes: 4 additions & 2 deletions xero_python/accounting/docs/AccountingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9887,7 +9887,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_overpayments**
> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size)
> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references)

Retrieves overpayments

Expand Down Expand Up @@ -9924,9 +9924,10 @@ order = 'Status ASC' # str | Order by an any element (optional)
page = 1 # int | e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional)
unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
page_size = 100 # int | Number of records to retrieve per page (optional)
references = ['&quot;Ref1&quot;, &quot;Ref2&quot;'] # list[str] | Filter by a comma-separated list of References (optional)
try:
# Retrieves overpayments
api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size)
api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountingApi->get_overpayments: %s\n" % e)
Expand All @@ -9943,6 +9944,7 @@ Name | Type | Description | Notes
**page** | **int**| e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment | [optional]
**unitdp** | **int**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
**page_size** | **int**| Number of records to retrieve per page | [optional]
**references** | [**list[str]**](str.md)| Filter by a comma-separated list of References | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions xero_python/accounting/docs/Overpayment.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Name | Type | Description | Notes
**applied_amount** | **float** | The amount of applied to an invoice | [optional]
**payments** | [**list[Payment]**](Payment.md) | See Payments | [optional]
**has_attachments** | **bool** | boolean to indicate if a overpayment has an attachment | [optional] [default to False]
**reference** | **str** | An optional description for Overpayment | [optional]
**attachments** | [**list[Attachment]**](Attachment.md) | See Attachments | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
29 changes: 29 additions & 0 deletions xero_python/accounting/models/overpayment.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ class Overpayment(BaseModel):
"applied_amount": "float",
"payments": "list[Payment]",
"has_attachments": "bool",
"reference": "str",
"attachments": "list[Attachment]",
}

Expand All @@ -70,6 +71,7 @@ class Overpayment(BaseModel):
"applied_amount": "AppliedAmount",
"payments": "Payments",
"has_attachments": "HasAttachments",
"reference": "Reference",
"attachments": "Attachments",
}

Expand All @@ -93,6 +95,7 @@ def __init__(
applied_amount=None,
payments=None,
has_attachments=False,
reference=None,
attachments=None,
): # noqa: E501
"""Overpayment - a model defined in OpenAPI""" # noqa: E501
Expand All @@ -115,6 +118,7 @@ def __init__(
self._applied_amount = None
self._payments = None
self._has_attachments = None
self._reference = None
self._attachments = None
self.discriminator = None

Expand Down Expand Up @@ -154,6 +158,8 @@ def __init__(
self.payments = payments
if has_attachments is not None:
self.has_attachments = has_attachments
if reference is not None:
self.reference = reference
if attachments is not None:
self.attachments = attachments

Expand Down Expand Up @@ -588,6 +594,29 @@ def has_attachments(self, has_attachments):

self._has_attachments = has_attachments

@property
def reference(self):
"""Gets the reference of this Overpayment. # noqa: E501

An optional description for Overpayment # noqa: E501

:return: The reference of this Overpayment. # noqa: E501
:rtype: str
"""
return self._reference

@reference.setter
def reference(self, reference):
"""Sets the reference of this Overpayment.

An optional description for Overpayment # noqa: E501

:param reference: The reference of this Overpayment. # noqa: E501
:type: str
"""

self._reference = reference

@property
def attachments(self):
"""Gets the attachments of this Overpayment. # noqa: E501
Expand Down
2 changes: 1 addition & 1 deletion xero_python/appstore/api/app_store_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 9.3.0
OpenAPI spec version: 10.1.0
"""


Expand Down
2 changes: 1 addition & 1 deletion xero_python/assets/api/asset_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 9.3.0
OpenAPI spec version: 10.1.0
"""


Expand Down
Loading
Loading