Skip to content
Merged
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
22 changes: 21 additions & 1 deletion docs/v1/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1984,6 +1984,11 @@
"description" : "Xero identifier",
"format" : "uuid"
},
"MergedToContactID" : {
"type" : "string",
"description" : "ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.",
"format" : "uuid"
},
"ContactNumber" : {
"maxLength" : 50,
"type" : "string",
Expand Down Expand Up @@ -2014,6 +2019,11 @@
"type" : "string",
"description" : "Last name of contact person (max length = 255)"
},
"CompanyNumber" : {
"maxLength" : 50,
"type" : "string",
"description" : "Company registration number (max length = 50)"
},
"EmailAddress" : {
"maxLength" : 255,
"type" : "string",
Expand Down Expand Up @@ -2069,6 +2079,16 @@
"type" : "boolean",
"description" : "true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact."
},
"SalesDefaultLineAmountType" : {
"type" : "string",
"description" : "The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.",
"enum" : [ "INCLUSIVE", "EXCLUSIVE", "NONE" ]
},
"PurchasesDefaultLineAmountType" : {
"type" : "string",
"description" : "The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.",
"enum" : [ "INCLUSIVE", "EXCLUSIVE", "NONE" ]
},
"DefaultCurrency" : {
"$ref" : "#/components/schemas/CurrencyCode"
},
Expand Down Expand Up @@ -5956,7 +5976,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>1.10.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.11.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
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="1.10.0",
version="1.11.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__ = "1.10.0"
__version__ = "1.11.0"
2 changes: 1 addition & 1 deletion xero_python/accounting/api/accounting_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"""

"""
OpenAPI spec version: 2.17.1
OpenAPI spec version: 2.17.2
"""

import importlib
Expand Down
4 changes: 4 additions & 0 deletions xero_python/accounting/docs/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**contact_id** | **str** | Xero identifier | [optional]
**merged_to_contact_id** | **str** | ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. | [optional]
**contact_number** | **str** | This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length &#x3D; 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. | [optional]
**account_number** | **str** | A user defined account number. This can be updated via the API and the Xero UI (max length &#x3D; 50) | [optional]
**contact_status** | **str** | Current status of a contact – see contact status types | [optional]
**name** | **str** | Full name of contact/organisation (max length &#x3D; 255) | [optional]
**first_name** | **str** | First name of contact person (max length &#x3D; 255) | [optional]
**last_name** | **str** | Last name of contact person (max length &#x3D; 255) | [optional]
**company_number** | **str** | Company registration number (max length &#x3D; 50) | [optional]
**email_address** | **str** | Email address of contact person (umlauts not supported) (max length &#x3D; 255) | [optional]
**skype_user_name** | **str** | Skype user name of contact | [optional]
**contact_persons** | [**list[ContactPerson]**](ContactPerson.md) | See contact persons | [optional]
Expand All @@ -21,6 +23,8 @@ Name | Type | Description | Notes
**phones** | [**list[Phone]**](Phone.md) | Store certain phone types for a contact – see phone types | [optional]
**is_supplier** | **bool** | true or false – Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. | [optional]
**is_customer** | **bool** | true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. | [optional]
**sales_default_line_amount_type** | **str** | The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. | [optional]
**purchases_default_line_amount_type** | **str** | The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. | [optional]
**default_currency** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
**xero_network_key** | **str** | Store XeroNetworkKey for contacts. | [optional]
**sales_default_account_code** | **str** | The default sales account code for contacts | [optional]
Expand Down
139 changes: 139 additions & 0 deletions xero_python/accounting/models/contact.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,14 @@ class Contact(BaseModel):
"""
openapi_types = {
"contact_id": "str",
"merged_to_contact_id": "str",
"contact_number": "str",
"account_number": "str",
"contact_status": "str",
"name": "str",
"first_name": "str",
"last_name": "str",
"company_number": "str",
"email_address": "str",
"skype_user_name": "str",
"contact_persons": "list[ContactPerson]",
Expand All @@ -48,6 +50,8 @@ class Contact(BaseModel):
"phones": "list[Phone]",
"is_supplier": "bool",
"is_customer": "bool",
"sales_default_line_amount_type": "str",
"purchases_default_line_amount_type": "str",
"default_currency": "CurrencyCode",
"xero_network_key": "str",
"sales_default_account_code": "str",
Expand All @@ -73,12 +77,14 @@ class Contact(BaseModel):

attribute_map = {
"contact_id": "ContactID",
"merged_to_contact_id": "MergedToContactID",
"contact_number": "ContactNumber",
"account_number": "AccountNumber",
"contact_status": "ContactStatus",
"name": "Name",
"first_name": "FirstName",
"last_name": "LastName",
"company_number": "CompanyNumber",
"email_address": "EmailAddress",
"skype_user_name": "SkypeUserName",
"contact_persons": "ContactPersons",
Expand All @@ -90,6 +96,8 @@ class Contact(BaseModel):
"phones": "Phones",
"is_supplier": "IsSupplier",
"is_customer": "IsCustomer",
"sales_default_line_amount_type": "SalesDefaultLineAmountType",
"purchases_default_line_amount_type": "PurchasesDefaultLineAmountType",
"default_currency": "DefaultCurrency",
"xero_network_key": "XeroNetworkKey",
"sales_default_account_code": "SalesDefaultAccountCode",
Expand All @@ -116,12 +124,14 @@ class Contact(BaseModel):
def __init__(
self,
contact_id=None,
merged_to_contact_id=None,
contact_number=None,
account_number=None,
contact_status=None,
name=None,
first_name=None,
last_name=None,
company_number=None,
email_address=None,
skype_user_name=None,
contact_persons=None,
Expand All @@ -133,6 +143,8 @@ def __init__(
phones=None,
is_supplier=None,
is_customer=None,
sales_default_line_amount_type=None,
purchases_default_line_amount_type=None,
default_currency=None,
xero_network_key=None,
sales_default_account_code=None,
Expand All @@ -158,12 +170,14 @@ def __init__(
"""Contact - a model defined in OpenAPI""" # noqa: E501

self._contact_id = None
self._merged_to_contact_id = None
self._contact_number = None
self._account_number = None
self._contact_status = None
self._name = None
self._first_name = None
self._last_name = None
self._company_number = None
self._email_address = None
self._skype_user_name = None
self._contact_persons = None
Expand All @@ -175,6 +189,8 @@ def __init__(
self._phones = None
self._is_supplier = None
self._is_customer = None
self._sales_default_line_amount_type = None
self._purchases_default_line_amount_type = None
self._default_currency = None
self._xero_network_key = None
self._sales_default_account_code = None
Expand All @@ -200,6 +216,8 @@ def __init__(

if contact_id is not None:
self.contact_id = contact_id
if merged_to_contact_id is not None:
self.merged_to_contact_id = merged_to_contact_id
if contact_number is not None:
self.contact_number = contact_number
if account_number is not None:
Expand All @@ -212,6 +230,8 @@ def __init__(
self.first_name = first_name
if last_name is not None:
self.last_name = last_name
if company_number is not None:
self.company_number = company_number
if email_address is not None:
self.email_address = email_address
if skype_user_name is not None:
Expand All @@ -234,6 +254,10 @@ def __init__(
self.is_supplier = is_supplier
if is_customer is not None:
self.is_customer = is_customer
if sales_default_line_amount_type is not None:
self.sales_default_line_amount_type = sales_default_line_amount_type
if purchases_default_line_amount_type is not None:
self.purchases_default_line_amount_type = purchases_default_line_amount_type
if default_currency is not None:
self.default_currency = default_currency
if xero_network_key is not None:
Expand Down Expand Up @@ -300,6 +324,29 @@ def contact_id(self, contact_id):

self._contact_id = contact_id

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

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. # noqa: E501

:return: The merged_to_contact_id of this Contact. # noqa: E501
:rtype: str
"""
return self._merged_to_contact_id

@merged_to_contact_id.setter
def merged_to_contact_id(self, merged_to_contact_id):
"""Sets the merged_to_contact_id of this Contact.

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber. # noqa: E501

:param merged_to_contact_id: The merged_to_contact_id of this Contact. # noqa: E501
:type: str
"""

self._merged_to_contact_id = merged_to_contact_id

@property
def contact_number(self):
"""Gets the contact_number of this Contact. # noqa: E501
Expand Down Expand Up @@ -472,6 +519,34 @@ def last_name(self, last_name):

self._last_name = last_name

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

Company registration number (max length = 50) # noqa: E501

:return: The company_number of this Contact. # noqa: E501
:rtype: str
"""
return self._company_number

@company_number.setter
def company_number(self, company_number):
"""Sets the company_number of this Contact.

Company registration number (max length = 50) # noqa: E501

:param company_number: The company_number of this Contact. # noqa: E501
:type: str
"""
if company_number is not None and len(company_number) > 50:
raise ValueError(
"Invalid value for `company_number`, "
"length must be less than or equal to `50`"
) # noqa: E501

self._company_number = company_number

@property
def email_address(self):
"""Gets the email_address of this Contact. # noqa: E501
Expand Down Expand Up @@ -735,6 +810,70 @@ def is_customer(self, is_customer):

self._is_customer = is_customer

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

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. # noqa: E501

:return: The sales_default_line_amount_type of this Contact. # noqa: E501
:rtype: str
"""
return self._sales_default_line_amount_type

@sales_default_line_amount_type.setter
def sales_default_line_amount_type(self, sales_default_line_amount_type):
"""Sets the sales_default_line_amount_type of this Contact.

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. # noqa: E501

:param sales_default_line_amount_type: The sales_default_line_amount_type of this Contact. # noqa: E501
:type: str
"""
allowed_values = ["INCLUSIVE", "EXCLUSIVE", "NONE", "None"] # noqa: E501

if sales_default_line_amount_type:
if sales_default_line_amount_type not in allowed_values:
raise ValueError(
"Invalid value for `sales_default_line_amount_type` ({0}), must be one of {1}".format( # noqa: E501
sales_default_line_amount_type, allowed_values
)
)

self._sales_default_line_amount_type = sales_default_line_amount_type

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

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. # noqa: E501

:return: The purchases_default_line_amount_type of this Contact. # noqa: E501
:rtype: str
"""
return self._purchases_default_line_amount_type

@purchases_default_line_amount_type.setter
def purchases_default_line_amount_type(self, purchases_default_line_amount_type):
"""Sets the purchases_default_line_amount_type of this Contact.

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber. # noqa: E501

:param purchases_default_line_amount_type: The purchases_default_line_amount_type of this Contact. # noqa: E501
:type: str
"""
allowed_values = ["INCLUSIVE", "EXCLUSIVE", "NONE", "None"] # noqa: E501

if purchases_default_line_amount_type:
if purchases_default_line_amount_type not in allowed_values:
raise ValueError(
"Invalid value for `purchases_default_line_amount_type` ({0}), must be one of {1}".format( # noqa: E501
purchases_default_line_amount_type, allowed_values
)
)

self._purchases_default_line_amount_type = purchases_default_line_amount_type

@property
def default_currency(self):
"""Gets the default_currency of this Contact. # 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 @@ -10,7 +10,7 @@
"""

"""
OpenAPI spec version: 2.17.1
OpenAPI spec version: 2.17.2
"""

import importlib
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 @@ -10,7 +10,7 @@
"""

"""
OpenAPI spec version: 2.17.1
OpenAPI spec version: 2.17.2
"""

import importlib
Expand Down
4 changes: 2 additions & 2 deletions xero_python/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X

The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project:

- API version: 2.17.1
- Package version: 1.10.0
- API version: 2.17.2
- Package version: 1.11.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://developer.xero.com](https://developer.xero.com)

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

"""
OpenAPI spec version: 2.17.1
OpenAPI spec version: 2.17.2
"""

import importlib
Expand Down
Loading