diff --git a/docs/accounting/CreditNote.md b/docs/accounting/CreditNote.md index 5ea7689a..6cd3dffc 100644 --- a/docs/accounting/CreditNote.md +++ b/docs/accounting/CreditNote.md @@ -34,6 +34,7 @@ Name | Type | Description | Notes **has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional] [default to false] **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] **warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional] +**invoice_addresses** | [**Array<InvoiceAddress>**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional] ## Code Sample @@ -69,7 +70,8 @@ instance = XeroRuby::Accounting::CreditNote.new(type: null, has_attachments: false, has_errors: false, validation_errors: null, - warnings: null) + warnings: null, + invoice_addresses: null) ``` diff --git a/docs/accounting/Invoice.md b/docs/accounting/Invoice.md index 9577802b..5d92ff9e 100644 --- a/docs/accounting/Invoice.md +++ b/docs/accounting/Invoice.md @@ -44,6 +44,7 @@ Name | Type | Description | Notes **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] **warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional] +**invoice_addresses** | [**Array<InvoiceAddress>**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional] ## Code Sample @@ -89,7 +90,8 @@ instance = XeroRuby::Accounting::Invoice.new(type: null, has_errors: false, status_attribute_string: null, validation_errors: null, - warnings: null) + warnings: null, + invoice_addresses: null) ``` diff --git a/docs/accounting/InvoiceAddress.md b/docs/accounting/InvoiceAddress.md new file mode 100644 index 00000000..3fa7df0f --- /dev/null +++ b/docs/accounting/InvoiceAddress.md @@ -0,0 +1,33 @@ +# XeroRuby::Accounting::InvoiceAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoice_address_type** | **String** | Indicates whether the address is defined as origin (FROM) or destination (TO) | [optional] +**address_line1** | **String** | First line of a physical address | [optional] +**address_line2** | **String** | Second line of a physical address | [optional] +**address_line3** | **String** | Third line of a physical address | [optional] +**address_line4** | **String** | Fourth line of a physical address | [optional] +**city** | **String** | City of a physical address | [optional] +**region** | **String** | Region or state of a physical address | [optional] +**postal_code** | **String** | Postal code of a physical address | [optional] +**country** | **String** | Country of a physical address | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::InvoiceAddress.new(invoice_address_type: null, + address_line1: null, + address_line2: null, + address_line3: null, + address_line4: null, + city: null, + region: null, + postal_code: null, + country: null) +``` + + diff --git a/docs/accounting/LineItem.md b/docs/accounting/LineItem.md index 8d690d3c..fcd9f24f 100644 --- a/docs/accounting/LineItem.md +++ b/docs/accounting/LineItem.md @@ -19,6 +19,9 @@ Name | Type | Description | Notes **discount_rate** | **BigDecimal** | 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** | **BigDecimal** | 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** | **String** | The Xero identifier for a Repeating Invoice | [optional] +**taxability** | **String** | The type of taxability | [optional] +**sales_tax_code_id** | **Float** | The ID of the sales tax code | [optional] +**tax_breakdown** | [**Array<TaxBreakdownComponent>**](TaxBreakdownComponent.md) | An array of tax components defined for this line item | [optional] ## Code Sample @@ -39,7 +42,10 @@ instance = XeroRuby::Accounting::LineItem.new(line_item_id: 00000000-0000-0000-0 tracking: null, discount_rate: null, discount_amount: null, - repeating_invoice_id: 00000000-0000-0000-0000-000000000000) + repeating_invoice_id: 00000000-0000-0000-0000-000000000000, + taxability: null, + sales_tax_code_id: null, + tax_breakdown: null) ``` diff --git a/docs/accounting/TaxBreakdownComponent.md b/docs/accounting/TaxBreakdownComponent.md new file mode 100644 index 00000000..79740998 --- /dev/null +++ b/docs/accounting/TaxBreakdownComponent.md @@ -0,0 +1,35 @@ +# XeroRuby::Accounting::TaxBreakdownComponent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tax_component_id** | **String** | The unique ID number of this component | [optional] +**type** | **String** | The type of the jurisdiction | [optional] +**name** | **String** | 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** | **String** | The state assigned number of the jurisdiction | [optional] +**jurisdiction_region** | **String** | Name identifying the region within the country | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::TaxBreakdownComponent.new(tax_component_id: null, + type: null, + name: null, + tax_percentage: null, + tax_amount: null, + taxable_amount: null, + non_taxable_amount: null, + exempt_amount: null, + state_assigned_no: null, + jurisdiction_region: null) +``` + + diff --git a/docs/accounting/index.html b/docs/accounting/index.html index db3d3764..8e95807e 100644 --- a/docs/accounting/index.html +++ b/docs/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" : "", @@ -6216,7 +6339,7 @@