Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build from OAS 6.3.0 #153

Merged
merged 3 commits into from
Sep 16, 2024
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
125 changes: 124 additions & 1 deletion docs/v1/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2564,6 +2564,13 @@
"items" : {
"$ref" : "#/components/schemas/ValidationError"
}
},
"InvoiceAddresses" : {
"type" : "array",
"description" : "An array of addresses used to auto calculate sales tax",
"items" : {
"$ref" : "#/components/schemas/InvoiceAddress"
}
}
},
"description" : "",
Expand Down Expand Up @@ -3259,12 +3266,63 @@
"items" : {
"$ref" : "#/components/schemas/ValidationError"
}
},
"InvoiceAddresses" : {
"type" : "array",
"description" : "An array of addresses used to auto calculate sales tax",
"items" : {
"$ref" : "#/components/schemas/InvoiceAddress"
}
}
},
"description" : "",
"externalDocs" : {
"url" : "http://developer.xero.com/documentation/api/invoices/"
}
};
defs["InvoiceAddress"] = {
"title" : "",
"type" : "object",
"properties" : {
"InvoiceAddressType" : {
"type" : "string",
"description" : "Indicates whether the address is defined as origin (FROM) or destination (TO)",
"enum" : [ "FROM", "TO" ]
},
"AddressLine1" : {
"type" : "string",
"description" : "First line of a physical address"
},
"AddressLine2" : {
"type" : "string",
"description" : "Second line of a physical address"
},
"AddressLine3" : {
"type" : "string",
"description" : "Third line of a physical address"
},
"AddressLine4" : {
"type" : "string",
"description" : "Fourth line of a physical address"
},
"City" : {
"type" : "string",
"description" : "City of a physical address"
},
"Region" : {
"type" : "string",
"description" : "Region or state of a physical address"
},
"PostalCode" : {
"type" : "string",
"description" : "Postal code of a physical address"
},
"Country" : {
"type" : "string",
"description" : "Country of a physical address"
}
},
"description" : ""
};
defs["InvoiceReminder"] = {
"title" : "",
Expand Down Expand Up @@ -3660,6 +3718,22 @@
"description" : "The Xero identifier for a Repeating Invoice",
"format" : "uuid",
"example" : "00000000-0000-0000-0000-000000000000"
},
"Taxability" : {
"type" : "string",
"description" : "The type of taxability",
"enum" : [ "TAXABLE", "NON_TAXABLE", "EXEMPT", "PART_TAXABLE", "NOT_APPLICABLE" ]
},
"SalesTaxCodeId" : {
"type" : "number",
"description" : "The ID of the sales tax code"
},
"TaxBreakdown" : {
"type" : "array",
"description" : "An array of tax components defined for this line item",
"items" : {
"$ref" : "#/components/schemas/TaxBreakdownComponent"
}
}
},
"description" : "",
Expand Down Expand Up @@ -5699,6 +5773,55 @@
"externalDocs" : {
"url" : "https://developer.xero.com/documentation/api-guides/conversions"
}
};
defs["TaxBreakdownComponent"] = {
"title" : "",
"type" : "object",
"properties" : {
"TaxComponentId" : {
"type" : "string",
"description" : "The unique ID number of this component",
"format" : "uuid"
},
"Type" : {
"type" : "string",
"description" : "The type of the jurisdiction",
"enum" : [ "SYSGST/USCOUNTRY", "SYSGST/USSTATE", "SYSGST/USCOUNTY", "SYSGST/USCITY", "SYSGST/USSPECIAL" ]
},
"Name" : {
"type" : "string",
"description" : "The name of the jurisdiction"
},
"TaxPercentage" : {
"type" : "number",
"description" : "The percentage of the tax"
},
"TaxAmount" : {
"type" : "number",
"description" : "The amount of the tax"
},
"TaxableAmount" : {
"type" : "number",
"description" : "The amount that is taxable"
},
"NonTaxableAmount" : {
"type" : "number",
"description" : "The amount that is not taxable"
},
"ExemptAmount" : {
"type" : "number",
"description" : "The amount that is exempt"
},
"StateAssignedNo" : {
"type" : "string",
"description" : "The state assigned number of the jurisdiction"
},
"JurisdictionRegion" : {
"type" : "string",
"description" : "Name identifying the region within the country"
}
},
"description" : ""
};
defs["TaxComponent"] = {
"title" : "",
Expand Down Expand Up @@ -6216,7 +6339,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>6.2.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>6.3.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 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>6.2.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>6.3.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 @@ -1392,7 +1392,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>6.2.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>6.3.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>6.2.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>6.3.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 @@ -2737,7 +2737,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>6.2.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>6.3.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>6.2.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>6.3.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
2 changes: 1 addition & 1 deletion docs/v1/payroll-nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4031,7 +4031,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>6.2.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>6.3.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
12 changes: 10 additions & 2 deletions docs/v1/payroll-uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1750,6 +1750,13 @@
"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\"",
"format" : "double"
},
"scheduleOfAccrualDate" : {
"type" : "string",
"description" : "The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\"",
"format" : "date",
"example" : "2024-04-01",
"x-is-date" : true
}
},
"description" : ""
Expand Down Expand Up @@ -3510,7 +3517,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>6.2.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>6.3.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 Expand Up @@ -4928,7 +4935,8 @@ <h3>Usage and SDK Samples</h3>
employee_leave_type = EmployeeLeaveType(
leave_type_id = "00000000-0000-0000-0000-000000000000",
schedule_of_accrual = schedule_of_accrual::BEGINNINGOFCALENDARYEAR,
opening_balance = 5.25)
opening_balance = 5.25,
schedule_of_accrual_date = 2024-05-01)

try:
api_response = api_instance.create_employee_leave_type(xero_tenant_id, employee_id, employeeLeaveType, idempotency_key)
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>6.2.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>6.3.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="6.2.0",
version="6.3.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__ = "6.2.0"
__version__ = "6.3.0"
2 changes: 2 additions & 0 deletions xero_python/accounting/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
ImportSummaryOrganisation,
)
from xero_python.accounting.models.invoice import Invoice
from xero_python.accounting.models.invoice_address import InvoiceAddress
from xero_python.accounting.models.invoice_reminder import InvoiceReminder
from xero_python.accounting.models.invoice_reminders import InvoiceReminders
from xero_python.accounting.models.invoices import Invoices
Expand Down Expand Up @@ -144,6 +145,7 @@
from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory
from xero_python.accounting.models.schedule import Schedule
from xero_python.accounting.models.setup import Setup
from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent
from xero_python.accounting.models.tax_component import TaxComponent
from xero_python.accounting.models.tax_rate import TaxRate
from xero_python.accounting.models.tax_rates import TaxRates
Expand Down
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 @@ -21,7 +21,7 @@
"""

"""
OpenAPI spec version: 6.2.0
OpenAPI spec version: 6.3.0
"""


Expand Down
1 change: 1 addition & 0 deletions xero_python/accounting/docs/CreditNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Name | Type | Description | Notes
**has_errors** | **bool** | A boolean to indicate if a credit note has an validation errors | [optional] [default to False]
**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional]
**invoice_addresses** | [**list[InvoiceAddress]**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [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
1 change: 1 addition & 0 deletions xero_python/accounting/docs/Invoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Name | Type | Description | Notes
**status_attribute_string** | **str** | A string to indicate if a invoice status | [optional]
**validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional]
**invoice_addresses** | [**list[InvoiceAddress]**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [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
18 changes: 18 additions & 0 deletions xero_python/accounting/docs/InvoiceAddress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# InvoiceAddress

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**invoice_address_type** | **str** | Indicates whether the address is defined as origin (FROM) or destination (TO) | [optional]
**address_line1** | **str** | First line of a physical address | [optional]
**address_line2** | **str** | Second line of a physical address | [optional]
**address_line3** | **str** | Third line of a physical address | [optional]
**address_line4** | **str** | Fourth line of a physical address | [optional]
**city** | **str** | City of a physical address | [optional]
**region** | **str** | Region or state of a physical address | [optional]
**postal_code** | **str** | Postal code of a physical address | [optional]
**country** | **str** | Country of a physical address | [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)


3 changes: 3 additions & 0 deletions xero_python/accounting/docs/LineItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ Name | Type | Description | Notes
**discount_rate** | **float** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
**discount_amount** | **float** | Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts. | [optional]
**repeating_invoice_id** | **str** | The Xero identifier for a Repeating Invoice | [optional]
**taxability** | **str** | The type of taxability | [optional]
**sales_tax_code_id** | **float** | The ID of the sales tax code | [optional]
**tax_breakdown** | [**list[TaxBreakdownComponent]**](TaxBreakdownComponent.md) | An array of tax components defined for this line item | [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
19 changes: 19 additions & 0 deletions xero_python/accounting/docs/TaxBreakdownComponent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# TaxBreakdownComponent

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tax_component_id** | **str** | The unique ID number of this component | [optional]
**type** | **str** | The type of the jurisdiction | [optional]
**name** | **str** | The name of the jurisdiction | [optional]
**tax_percentage** | **float** | The percentage of the tax | [optional]
**tax_amount** | **float** | The amount of the tax | [optional]
**taxable_amount** | **float** | The amount that is taxable | [optional]
**non_taxable_amount** | **float** | The amount that is not taxable | [optional]
**exempt_amount** | **float** | The amount that is exempt | [optional]
**state_assigned_no** | **str** | The state assigned number of the jurisdiction | [optional]
**jurisdiction_region** | **str** | Name identifying the region within the country | [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)


2 changes: 2 additions & 0 deletions xero_python/accounting/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
ImportSummaryOrganisation,
)
from xero_python.accounting.models.invoice import Invoice
from xero_python.accounting.models.invoice_address import InvoiceAddress
from xero_python.accounting.models.invoice_reminder import InvoiceReminder
from xero_python.accounting.models.invoice_reminders import InvoiceReminders
from xero_python.accounting.models.invoices import Invoices
Expand Down Expand Up @@ -139,6 +140,7 @@
from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory
from xero_python.accounting.models.schedule import Schedule
from xero_python.accounting.models.setup import Setup
from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent
from xero_python.accounting.models.tax_component import TaxComponent
from xero_python.accounting.models.tax_rate import TaxRate
from xero_python.accounting.models.tax_rates import TaxRates
Expand Down
Loading