[UST-4371] Add USST fields to Invoices and Credit Notes endpoints

Author: sangeet-joy_xero

docs/v1/accounting/index.html

@@ -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" : "",
@@ -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" : "",
@@ -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" : "",
@@ -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" : "",

xero_python/accounting/__init__.py

@@ -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
@@ -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

xero_python/accounting/docs/CreditNote.md

@@ -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)
 

xero_python/accounting/docs/Invoice.md

@@ -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)
 

xero_python/accounting/docs/InvoiceAddress.md

@@ -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)
+
+

xero_python/accounting/docs/LineItem.md

@@ -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)
 

xero_python/accounting/docs/TaxBreakdownComponent.md

@@ -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)
+
+

xero_python/accounting/models/__init__.py

@@ -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
@@ -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

xero_python/accounting/models/credit_note.py

@@ -60,6 +60,7 @@ class CreditNote(BaseModel):
         "has_errors": "bool",
         "validation_errors": "list[ValidationError]",
         "warnings": "list[ValidationError]",
+        "invoice_addresses": "list[InvoiceAddress]",
     }
 
     attribute_map = {
@@ -93,6 +94,7 @@ class CreditNote(BaseModel):
         "has_errors": "HasErrors",
         "validation_errors": "ValidationErrors",
         "warnings": "Warnings",
+        "invoice_addresses": "InvoiceAddresses",
     }
 
     def __init__(
@@ -127,6 +129,7 @@ def __init__(
         has_errors=False,
         validation_errors=None,
         warnings=None,
+        invoice_addresses=None,
     ):  # noqa: E501
         """CreditNote - a model defined in OpenAPI"""  # noqa: E501
 
@@ -160,6 +163,7 @@ def __init__(
         self._has_errors = None
         self._validation_errors = None
         self._warnings = None
+        self._invoice_addresses = None
         self.discriminator = None
 
         if type is not None:
@@ -222,6 +226,8 @@ def __init__(
             self.validation_errors = validation_errors
         if warnings is not None:
             self.warnings = warnings
+        if invoice_addresses is not None:
+            self.invoice_addresses = invoice_addresses
 
     @property
     def type(self):
@@ -932,3 +938,26 @@ def warnings(self, warnings):
         """
 
         self._warnings = warnings
+
+    @property
+    def invoice_addresses(self):
+        """Gets the invoice_addresses of this CreditNote.  # noqa: E501
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :return: The invoice_addresses of this CreditNote.  # noqa: E501
+        :rtype: list[InvoiceAddress]
+        """
+        return self._invoice_addresses
+
+    @invoice_addresses.setter
+    def invoice_addresses(self, invoice_addresses):
+        """Sets the invoice_addresses of this CreditNote.
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :param invoice_addresses: The invoice_addresses of this CreditNote.  # noqa: E501
+        :type: list[InvoiceAddress]
+        """
+
+        self._invoice_addresses = invoice_addresses

xero_python/accounting/models/invoice.py

@@ -70,6 +70,7 @@ class Invoice(BaseModel):
         "status_attribute_string": "str",
         "validation_errors": "list[ValidationError]",
         "warnings": "list[ValidationError]",
+        "invoice_addresses": "list[InvoiceAddress]",
     }
 
     attribute_map = {
@@ -113,6 +114,7 @@ class Invoice(BaseModel):
         "status_attribute_string": "StatusAttributeString",
         "validation_errors": "ValidationErrors",
         "warnings": "Warnings",
+        "invoice_addresses": "InvoiceAddresses",
     }
 
     def __init__(
@@ -157,6 +159,7 @@ def __init__(
         status_attribute_string=None,
         validation_errors=None,
         warnings=None,
+        invoice_addresses=None,
     ):  # noqa: E501
         """Invoice - a model defined in OpenAPI"""  # noqa: E501
 
@@ -200,6 +203,7 @@ def __init__(
         self._status_attribute_string = None
         self._validation_errors = None
         self._warnings = None
+        self._invoice_addresses = None
         self.discriminator = None
 
         if type is not None:
@@ -282,6 +286,8 @@ def __init__(
             self.validation_errors = validation_errors
         if warnings is not None:
             self.warnings = warnings
+        if invoice_addresses is not None:
+            self.invoice_addresses = invoice_addresses
 
     @property
     def type(self):
@@ -1237,3 +1243,26 @@ def warnings(self, warnings):
         """
 
         self._warnings = warnings
+
+    @property
+    def invoice_addresses(self):
+        """Gets the invoice_addresses of this Invoice.  # noqa: E501
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :return: The invoice_addresses of this Invoice.  # noqa: E501
+        :rtype: list[InvoiceAddress]
+        """
+        return self._invoice_addresses
+
+    @invoice_addresses.setter
+    def invoice_addresses(self, invoice_addresses):
+        """Sets the invoice_addresses of this Invoice.
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :param invoice_addresses: The invoice_addresses of this Invoice.  # noqa: E501
+        :type: list[InvoiceAddress]
+        """
+
+        self._invoice_addresses = invoice_addresses