Skip to content

Build from OAS 6.3.0 #312

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 16, 2024
Merged

Build from OAS 6.3.0 #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2e495f
Build from OAS 6.3.0
Sep 11, 2024
c4cb047
corrtected payroll docs
Sep 12, 2024
5c52f1f
[UST-4371] Add USST fields to Invoices and Credit Notes endpoints
Sep 16, 2024
2c9a1e4
Merge branch 'master' into OAS-6.3.0-ruby
sangeet-joy-tw Sep 16, 2024
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
4 changes: 3 additions & 1 deletion docs/accounting/CreditNote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
```


4 changes: 3 additions & 1 deletion docs/accounting/Invoice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
```


33 changes: 33 additions & 0 deletions docs/accounting/InvoiceAddress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
```


8 changes: 7 additions & 1 deletion docs/accounting/LineItem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
```


35 changes: 35 additions & 0 deletions docs/accounting/TaxBreakdownComponent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
```


125 changes: 124 additions & 1 deletion docs/accounting/index.html
View file
Open in desktop
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>9.2.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.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/app_store/index.html
View file
Open in desktop
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.2.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.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/assets/index.html
View file
Open in desktop
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>9.2.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.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/files/index.html
View file
Open in desktop
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.2.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.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/finance/index.html
View file
Open in desktop
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>9.2.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.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/payroll_au/index.html
View file
Open in desktop
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.2.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.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/payroll_nz/index.html
View file
Open in desktop
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>9.2.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.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
4 changes: 3 additions & 1 deletion docs/payroll_uk/EmployeeLeaveType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**maximum_to_accrue** | **Float** | The maximum number of hours that can be accrued for the leave | [optional]
**opening_balance** | **Float** | The initial number of hours assigned when the leave was added to the employee | [optional]
**rate_accrued_hourly** | **Float** | 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 \&quot;OnHourWorked\&quot; | [optional]
**schedule_of_accrual_date** | **Date** | The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \&quot;OnAnniversaryDate\&quot; | [optional]

## Code Sample

Expand All @@ -21,7 +22,8 @@ instance = XeroRuby::PayrollUk::EmployeeLeaveType.new(leave_type_id: null,
hours_accrued_annually: null,
maximum_to_accrue: null,
opening_balance: null,
rate_accrued_hourly: null)
rate_accrued_hourly: null,
schedule_of_accrual_date: Mon Apr 01 00:00:00 GMT 2024)
```


12 changes: 10 additions & 2 deletions docs/payroll_uk/index.html
View file
Open in desktop
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>9.2.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>9.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 @@ -4844,7 +4851,8 @@ <h3>Usage and SDK Samples</h3>
employee_leave_type = {
leave_type_id: "00000000-0000-0000-0000-000000000000",
schedule_of_accrual: XeroRuby::PayrollUk::EmployeeLeaveType::schedule_of_accrual::BEGINNINGOFCALENDARYEAR,
opening_balance: 5.25
opening_balance: 5.25,
schedule_of_accrual_date: 2024-05-01
}

begin
Expand Down
Loading
Loading