Merge pull request #168 from XeroAPI/budgets_and_reports_fixes

Add Budgets and Fix how nz aus Tax reports work
XeroAPI · May 28, 2021 · 4d79cde · 4d79cde
2 parents a0a7c98 + 5887ac6
commit 4d79cde
Show file tree

Hide file tree

Showing 24 changed files with 2,205 additions and 655 deletions.
diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md
diff --git a/docs/accounting/Budget.md b/docs/accounting/Budget.md
@@ -0,0 +1,27 @@
+# XeroRuby::Accounting::Budget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budget_id** | **String** | Xero identifier | [optional] 
+**type** | **String** | Type of Budget. OVERALL or TRACKING | [optional] 
+**description** | **String** | The Budget description | [optional] 
+**updated_date_utc** | **DateTime** | UTC timestamp of last update to budget | [optional] 
+**budget_lines** | [**BudgetLines**](BudgetLines.md) |  | [optional] 
+**tracking** | [**TrackingCategory**](TrackingCategory.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Budget.new(budget_id: null,
+                                 type: null,
+                                 description: null,
+                                 updated_date_utc: /Date(1573755038314)/,
+                                 budget_lines: null,
+                                 tracking: null)
+```
+
+
diff --git a/docs/accounting/BudgetLines.md b/docs/accounting/BudgetLines.md
@@ -0,0 +1,23 @@
+# XeroRuby::Accounting::BudgetLines
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period** | **Date** | Period the amount applies to (e.g. “2019-08”) | [optional] 
+**amount** | **Integer** | LineItem Quantity | [optional] 
+**unit_amount** | **Integer** | Budgeted amount | [optional] 
+**notes** | **String** | Any footnotes associated with this balance | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::BudgetLines.new(period: null,
+                                 amount: null,
+                                 unit_amount: null,
+                                 notes: null)
+```
+
+
diff --git a/docs/accounting/Budgets.md b/docs/accounting/Budgets.md
@@ -0,0 +1,17 @@
+# XeroRuby::Accounting::Budgets
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgets** | [**Array&lt;Budget&gt;**](Budget.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Budgets.new(budgets: null)
+```
+
+
diff --git a/docs/accounting/LineItem.md b/docs/accounting/LineItem.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **unit_amount** | **BigDecimal** | LineItem Unit Amount | [optional] 
 **item_code** | **String** | See Items | [optional] 
 **account_code** | **String** | See Accounts | [optional] 
+**account_id** | **String** | The associated account ID related to this line item | [optional] 
 **tax_type** | **String** | The tax type from TaxRates | [optional] 
 **tax_amount** | **BigDecimal** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated &lt;TaxAmount&gt; is not correct. | [optional] 
 **line_amount** | **BigDecimal** | If you wish to omit either of the &lt;Quantity&gt; or &lt;UnitAmount&gt; you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount &#x3D; Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional] 
@@ -29,6 +30,7 @@ instance = XeroRuby::Accounting::LineItem.new(line_item_id: 00000000-0000-0000-0
                                  unit_amount: null,
                                  item_code: null,
                                  account_code: null,
+                                 account_id: 00000000-0000-0000-0000-000000000000,
                                  tax_type: null,
                                  tax_amount: null,
                                  line_amount: null,

diff --git a/docs/accounting/Report.md b/docs/accounting/Report.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**report_id** | **String** | See Prepayment Types | [optional] 
 **report_name** | **String** | See Prepayment Types | [optional] 
 **report_type** | **String** | See Prepayment Types | [optional] 
 **report_title** | **String** | See Prepayment Types | [optional] 
@@ -17,8 +16,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'XeroRuby::Accounting'
 
-instance = XeroRuby::Accounting::Report.new(report_id: null,
-                                 report_name: null,
+instance = XeroRuby::Accounting::Report.new(report_name: null,
                                  report_type: null,
                                  report_title: null,
                                  report_date: null,

diff --git a/docs/accounting/ReportWithRow.md b/docs/accounting/ReportWithRow.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**report_id** | **String** | Report id | [optional] 
+**report_id** | **String** | ID of the Report | [optional] 
 **report_name** | **String** | Name of the report | [optional] 
 **report_title** | **String** | Title of the report | [optional] 
 **report_type** | **String** | The type of report (BalanceSheet,ProfitLoss, etc) | [optional]