Skip to content

Commit 30257b1

Browse files
sangeet-joy-twsangeet-joy-tw
authored
Build from OAS 6.3.0 (#312)
* Build from OAS 6.3.0
1 parent 209b188 commit 30257b1

23 files changed

+1039
-32
lines changed

‎docs/accounting/CreditNote.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
3434
**has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional] [default to false]
3535
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
3636
**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]
37+
**invoice_addresses** | [**Array<InvoiceAddress>**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional]
3738

3839
## Code Sample
3940

@@ -69,7 +70,8 @@ instance = XeroRuby::Accounting::CreditNote.new(type: null,
6970
has_attachments: false,
7071
has_errors: false,
7172
validation_errors: null,
72-
warnings: null)
73+
warnings: null,
74+
invoice_addresses: null)
7375
```
7476

7577

‎docs/accounting/Invoice.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Name | Type | Description | Notes
4444
**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
4545
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
4646
**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]
47+
**invoice_addresses** | [**Array<InvoiceAddress>**](InvoiceAddress.md) | An array of addresses used to auto calculate sales tax | [optional]
4748

4849
## Code Sample
4950

@@ -89,7 +90,8 @@ instance = XeroRuby::Accounting::Invoice.new(type: null,
8990
has_errors: false,
9091
status_attribute_string: null,
9192
validation_errors: null,
92-
warnings: null)
93+
warnings: null,
94+
invoice_addresses: null)
9395
```
9496

9597

‎docs/accounting/InvoiceAddress.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# XeroRuby::Accounting::InvoiceAddress
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**invoice_address_type** | **String** | Indicates whether the address is defined as origin (FROM) or destination (TO) | [optional]
8+
**address_line1** | **String** | First line of a physical address | [optional]
9+
**address_line2** | **String** | Second line of a physical address | [optional]
10+
**address_line3** | **String** | Third line of a physical address | [optional]
11+
**address_line4** | **String** | Fourth line of a physical address | [optional]
12+
**city** | **String** | City of a physical address | [optional]
13+
**region** | **String** | Region or state of a physical address | [optional]
14+
**postal_code** | **String** | Postal code of a physical address | [optional]
15+
**country** | **String** | Country of a physical address | [optional]
16+
17+
## Code Sample
18+
19+
```ruby
20+
require 'XeroRuby::Accounting'
21+
22+
instance = XeroRuby::Accounting::InvoiceAddress.new(invoice_address_type: null,
23+
address_line1: null,
24+
address_line2: null,
25+
address_line3: null,
26+
address_line4: null,
27+
city: null,
28+
region: null,
29+
postal_code: null,
30+
country: null)
31+
```
32+
33+

‎docs/accounting/LineItem.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Name | Type | Description | Notes
1919
**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]
2020
**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]
2121
**repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoice | [optional]
22+
**taxability** | **String** | The type of taxability | [optional]
23+
**sales_tax_code_id** | **Float** | The ID of the sales tax code | [optional]
24+
**tax_breakdown** | [**Array<TaxBreakdownComponent>**](TaxBreakdownComponent.md) | An array of tax components defined for this line item | [optional]
2225

2326
## Code Sample
2427

@@ -39,7 +42,10 @@ instance = XeroRuby::Accounting::LineItem.new(line_item_id: 00000000-0000-0000-0
3942
tracking: null,
4043
discount_rate: null,
4144
discount_amount: null,
42-
repeating_invoice_id: 00000000-0000-0000-0000-000000000000)
45+
repeating_invoice_id: 00000000-0000-0000-0000-000000000000,
46+
taxability: null,
47+
sales_tax_code_id: null,
48+
tax_breakdown: null)
4349
```
4450

4551

‎docs/accounting/TaxBreakdownComponent.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# XeroRuby::Accounting::TaxBreakdownComponent
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**tax_component_id** | **String** | The unique ID number of this component | [optional]
8+
**type** | **String** | The type of the jurisdiction | [optional]
9+
**name** | **String** | The name of the jurisdiction | [optional]
10+
**tax_percentage** | **Float** | The percentage of the tax | [optional]
11+
**tax_amount** | **Float** | The amount of the tax | [optional]
12+
**taxable_amount** | **Float** | The amount that is taxable | [optional]
13+
**non_taxable_amount** | **Float** | The amount that is not taxable | [optional]
14+
**exempt_amount** | **Float** | The amount that is exempt | [optional]
15+
**state_assigned_no** | **String** | The state assigned number of the jurisdiction | [optional]
16+
**jurisdiction_region** | **String** | Name identifying the region within the country | [optional]
17+
18+
## Code Sample
19+
20+
```ruby
21+
require 'XeroRuby::Accounting'
22+
23+
instance = XeroRuby::Accounting::TaxBreakdownComponent.new(tax_component_id: null,
24+
type: null,
25+
name: null,
26+
tax_percentage: null,
27+
tax_amount: null,
28+
taxable_amount: null,
29+
non_taxable_amount: null,
30+
exempt_amount: null,
31+
state_assigned_no: null,
32+
jurisdiction_region: null)
33+
```
34+
35+

‎docs/accounting/index.html

+124-1
Original file line numberDiff line numberDiff line change
@@ -2564,6 +2564,13 @@
25642564
"items" : {
25652565
"$ref" : "#/components/schemas/ValidationError"
25662566
}
2567+
},
2568+
"InvoiceAddresses" : {
2569+
"type" : "array",
2570+
"description" : "An array of addresses used to auto calculate sales tax",
2571+
"items" : {
2572+
"$ref" : "#/components/schemas/InvoiceAddress"
2573+
}
25672574
}
25682575
},
25692576
"description" : "",
@@ -3259,12 +3266,63 @@
32593266
"items" : {
32603267
"$ref" : "#/components/schemas/ValidationError"
32613268
}
3269+
},
3270+
"InvoiceAddresses" : {
3271+
"type" : "array",
3272+
"description" : "An array of addresses used to auto calculate sales tax",
3273+
"items" : {
3274+
"$ref" : "#/components/schemas/InvoiceAddress"
3275+
}
32623276
}
32633277
},
32643278
"description" : "",
32653279
"externalDocs" : {
32663280
"url" : "http://developer.xero.com/documentation/api/invoices/"
32673281
}
3282+
};
3283+
defs["InvoiceAddress"] = {
3284+
"title" : "",
3285+
"type" : "object",
3286+
"properties" : {
3287+
"InvoiceAddressType" : {
3288+
"type" : "string",
3289+
"description" : "Indicates whether the address is defined as origin (FROM) or destination (TO)",
3290+
"enum" : [ "FROM", "TO" ]
3291+
},
3292+
"AddressLine1" : {
3293+
"type" : "string",
3294+
"description" : "First line of a physical address"
3295+
},
3296+
"AddressLine2" : {
3297+
"type" : "string",
3298+
"description" : "Second line of a physical address"
3299+
},
3300+
"AddressLine3" : {
3301+
"type" : "string",
3302+
"description" : "Third line of a physical address"
3303+
},
3304+
"AddressLine4" : {
3305+
"type" : "string",
3306+
"description" : "Fourth line of a physical address"
3307+
},
3308+
"City" : {
3309+
"type" : "string",
3310+
"description" : "City of a physical address"
3311+
},
3312+
"Region" : {
3313+
"type" : "string",
3314+
"description" : "Region or state of a physical address"
3315+
},
3316+
"PostalCode" : {
3317+
"type" : "string",
3318+
"description" : "Postal code of a physical address"
3319+
},
3320+
"Country" : {
3321+
"type" : "string",
3322+
"description" : "Country of a physical address"
3323+
}
3324+
},
3325+
"description" : ""
32683326
};
32693327
defs["InvoiceReminder"] = {
32703328
"title" : "",
@@ -3660,6 +3718,22 @@
36603718
"description" : "The Xero identifier for a Repeating Invoice",
36613719
"format" : "uuid",
36623720
"example" : "00000000-0000-0000-0000-000000000000"
3721+
},
3722+
"Taxability" : {
3723+
"type" : "string",
3724+
"description" : "The type of taxability",
3725+
"enum" : [ "TAXABLE", "NON_TAXABLE", "EXEMPT", "PART_TAXABLE", "NOT_APPLICABLE" ]
3726+
},
3727+
"SalesTaxCodeId" : {
3728+
"type" : "number",
3729+
"description" : "The ID of the sales tax code"
3730+
},
3731+
"TaxBreakdown" : {
3732+
"type" : "array",
3733+
"description" : "An array of tax components defined for this line item",
3734+
"items" : {
3735+
"$ref" : "#/components/schemas/TaxBreakdownComponent"
3736+
}
36633737
}
36643738
},
36653739
"description" : "",
@@ -5699,6 +5773,55 @@
56995773
"externalDocs" : {
57005774
"url" : "https://developer.xero.com/documentation/api-guides/conversions"
57015775
}
5776+
};
5777+
defs["TaxBreakdownComponent"] = {
5778+
"title" : "",
5779+
"type" : "object",
5780+
"properties" : {
5781+
"TaxComponentId" : {
5782+
"type" : "string",
5783+
"description" : "The unique ID number of this component",
5784+
"format" : "uuid"
5785+
},
5786+
"Type" : {
5787+
"type" : "string",
5788+
"description" : "The type of the jurisdiction",
5789+
"enum" : [ "SYSGST/USCOUNTRY", "SYSGST/USSTATE", "SYSGST/USCOUNTY", "SYSGST/USCITY", "SYSGST/USSPECIAL" ]
5790+
},
5791+
"Name" : {
5792+
"type" : "string",
5793+
"description" : "The name of the jurisdiction"
5794+
},
5795+
"TaxPercentage" : {
5796+
"type" : "number",
5797+
"description" : "The percentage of the tax"
5798+
},
5799+
"TaxAmount" : {
5800+
"type" : "number",
5801+
"description" : "The amount of the tax"
5802+
},
5803+
"TaxableAmount" : {
5804+
"type" : "number",
5805+
"description" : "The amount that is taxable"
5806+
},
5807+
"NonTaxableAmount" : {
5808+
"type" : "number",
5809+
"description" : "The amount that is not taxable"
5810+
},
5811+
"ExemptAmount" : {
5812+
"type" : "number",
5813+
"description" : "The amount that is exempt"
5814+
},
5815+
"StateAssignedNo" : {
5816+
"type" : "string",
5817+
"description" : "The state assigned number of the jurisdiction"
5818+
},
5819+
"JurisdictionRegion" : {
5820+
"type" : "string",
5821+
"description" : "Name identifying the region within the country"
5822+
}
5823+
},
5824+
"description" : ""
57025825
};
57035826
defs["TaxComponent"] = {
57045827
"title" : "",
@@ -6216,7 +6339,7 @@
62166339
<nav id="scrollingNav">
62176340
<ul class="sidenav nav nav-list">
62186341
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6219-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.2.0</li>
6342+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.3.0</li>
62206343
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
62216344
<li data-group="Accounting" data-name="createAccount" class="">
62226345
<a href="#api-Accounting-createAccount">createAccount</a>

‎docs/app_store/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1241,7 +1241,7 @@
12411241
<nav id="scrollingNav">
12421242
<ul class="sidenav nav nav-list">
12431243
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1244-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.2.0</li>
1244+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.3.0</li>
12451245
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12461246
<li data-group="AppStore" data-name="getSubscription" class="">
12471247
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/assets/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1392,7 +1392,7 @@
13921392
<nav id="scrollingNav">
13931393
<ul class="sidenav nav nav-list">
13941394
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1395-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.2.0</li>
1395+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.3.0</li>
13961396
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13971397
<li data-group="Asset" data-name="createAsset" class="">
13981398
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/files/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1170,7 +1170,7 @@
11701170
<nav id="scrollingNav">
11711171
<ul class="sidenav nav nav-list">
11721172
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1173-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.2.0</li>
1173+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>9.3.0</li>
11741174
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11751175
<li data-group="Files" data-name="createFileAssociation" class="">
11761176
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/finance/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2737,7 +2737,7 @@
27372737
<nav id="scrollingNav">
27382738
<ul class="sidenav nav nav-list">
27392739
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2740-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.2.0</li>
2740+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.3.0</li>
27412741
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27422742
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27432743
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/payroll_au/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3412,7 +3412,7 @@
34123412
<nav id="scrollingNav">
34133413
<ul class="sidenav nav nav-list">
34143414
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3415-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.2.0</li>
3415+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.3.0</li>
34163416
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
34173417
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
34183418
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

‎docs/payroll_nz/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4031,7 +4031,7 @@
40314031
<nav id="scrollingNav">
40324032
<ul class="sidenav nav nav-list">
40334033
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
4034-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.2.0</li>
4034+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.3.0</li>
40354035
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
40364036
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
40374037
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

‎docs/payroll_uk/EmployeeLeaveType.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**maximum_to_accrue** | **Float** | The maximum number of hours that can be accrued for the leave | [optional]
1111
**opening_balance** | **Float** | The initial number of hours assigned when the leave was added to the employee | [optional]
1212
**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]
13+
**schedule_of_accrual_date** | **Date** | The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \&quot;OnAnniversaryDate\&quot; | [optional]
1314

1415
## Code Sample
1516

@@ -21,7 +22,8 @@ instance = XeroRuby::PayrollUk::EmployeeLeaveType.new(leave_type_id: null,
2122
hours_accrued_annually: null,
2223
maximum_to_accrue: null,
2324
opening_balance: null,
24-
rate_accrued_hourly: null)
25+
rate_accrued_hourly: null,
26+
schedule_of_accrual_date: Mon Apr 01 00:00:00 GMT 2024)
2527
```
2628

2729

‎docs/payroll_uk/index.html

+10-2
Original file line numberDiff line numberDiff line change
@@ -1750,6 +1750,13 @@
17501750
"type" : "number",
17511751
"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\"",
17521752
"format" : "double"
1753+
},
1754+
"scheduleOfAccrualDate" : {
1755+
"type" : "string",
1756+
"description" : "The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\"",
1757+
"format" : "date",
1758+
"example" : "2024-04-01",
1759+
"x-is-date" : true
17531760
}
17541761
},
17551762
"description" : ""
@@ -3510,7 +3517,7 @@
35103517
<nav id="scrollingNav">
35113518
<ul class="sidenav nav nav-list">
35123519
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3513-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>9.2.0</li>
3520+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>9.3.0</li>
35143521
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
35153522
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
35163523
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
@@ -4844,7 +4851,8 @@ <h3>Usage and SDK Samples</h3>
48444851
employee_leave_type = {
48454852
leave_type_id: "00000000-0000-0000-0000-000000000000",
48464853
schedule_of_accrual: XeroRuby::PayrollUk::EmployeeLeaveType::schedule_of_accrual::BEGINNINGOFCALENDARYEAR,
4847-
opening_balance: 5.25
4854+
opening_balance: 5.25,
4855+
schedule_of_accrual_date: 2024-05-01
48484856
}
48494857

48504858
begin

0 commit comments

Comments
 (0)