diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md index e1ccf660..e23ce662 100644 --- a/docs/accounting/AccountingApi.md +++ b/docs/accounting/AccountingApi.md @@ -90,6 +90,8 @@ Method | HTTP request | Description [**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Retrieves a specific branding theme using a unique branding theme Id [**get_branding_theme_payment_services**](AccountingApi.md#get_branding_theme_payment_services) | **GET** /BrandingThemes/{BrandingThemeID}/PaymentServices | Retrieves the payment services for a specific branding theme [**get_branding_themes**](AccountingApi.md#get_branding_themes) | **GET** /BrandingThemes | Retrieves all the branding themes +[**get_budget**](AccountingApi.md#get_budget) | **GET** /Budgets/{BudgetID} | Retrieves a specific budgets, which includes budget lines +[**get_budgets**](AccountingApi.md#get_budgets) | **GET** /Budgets | Retrieve a list of budgets [**get_contact**](AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Retrieves a specific contacts in a Xero organisation using a unique contact Id [**get_contact_attachment_by_file_name**](AccountingApi.md#get_contact_attachment_by_file_name) | **GET** /Contacts/{ContactID}/Attachments/{FileName} | Retrieves a specific attachment from a specific contact by file name [**get_contact_attachment_by_id**](AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Retrieves a specific attachment from a specific contact using a unique attachment Id @@ -177,15 +179,15 @@ Method | HTTP request | Description [**get_repeating_invoices**](AccountingApi.md#get_repeating_invoices) | **GET** /RepeatingInvoices | Retrieves repeating invoices [**get_report_aged_payables_by_contact**](AccountingApi.md#get_report_aged_payables_by_contact) | **GET** /Reports/AgedPayablesByContact | Retrieves report for aged payables by contact [**get_report_aged_receivables_by_contact**](AccountingApi.md#get_report_aged_receivables_by_contact) | **GET** /Reports/AgedReceivablesByContact | Retrieves report for aged receivables by contact -[**get_report_ba_sor_gst**](AccountingApi.md#get_report_ba_sor_gst) | **GET** /Reports/{ReportID} | Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) -[**get_report_ba_sor_gst_list**](AccountingApi.md#get_report_ba_sor_gst_list) | **GET** /Reports | Retrieves report for BAS (only valid for AU orgs) [**get_report_balance_sheet**](AccountingApi.md#get_report_balance_sheet) | **GET** /Reports/BalanceSheet | Retrieves report for balancesheet [**get_report_bank_summary**](AccountingApi.md#get_report_bank_summary) | **GET** /Reports/BankSummary | Retrieves report for bank summary [**get_report_budget_summary**](AccountingApi.md#get_report_budget_summary) | **GET** /Reports/BudgetSummary | Retrieves report for budget summary [**get_report_executive_summary**](AccountingApi.md#get_report_executive_summary) | **GET** /Reports/ExecutiveSummary | Retrieves report for executive summary +[**get_report_from_id**](AccountingApi.md#get_report_from_id) | **GET** /Reports/{ReportID} | Retrieves a specific report using a unique ReportID [**get_report_profit_and_loss**](AccountingApi.md#get_report_profit_and_loss) | **GET** /Reports/ProfitAndLoss | Retrieves report for profit and loss [**get_report_ten_ninety_nine**](AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Retrieve reports for 1099 [**get_report_trial_balance**](AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Retrieves report for trial balance +[**get_reports_list**](AccountingApi.md#get_reports_list) | **GET** /Reports | Retrieves a list of the organistaions unique reports that require a uuid to fetch [**get_tax_rates**](AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Retrieves tax rates [**get_tracking_categories**](AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Retrieves tracking categories and options [**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Retrieves specific tracking categories and options using a unique tracking category Id @@ -934,7 +936,7 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant branding_theme_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Branding Theme -payment_service = { "PaymentServiceID": "00000000-0000-0000-0000-000000000000", "PaymentServiceName": "ACME Payments", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Pay Now" } # PaymentService | PaymentService object in body of request +payment_service = { "PaymentServiceID": "00000000-0000-0000-0000-000000000000", "PaymentServiceName": "Payments Service", "PaymentServiceUrl": "https://www.paymentservice.com/", "PayNowText": "Pay Now" } # PaymentService | PaymentService object in body of request begin #Creates a new custom payment service for a specific branding theme result = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service) @@ -5990,6 +5992,143 @@ Name | Type | Description | Notes - **Accept**: application/json +## get_budget + +> Budgets get_budget(xero_tenant_id, budget_id) + +Retrieves a specific budgets, which includes budget lines + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +budget_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Budgets +begin + #Retrieves a specific budgets, which includes budget lines + result = api_instance.get_budget(xero_tenant_id, budget_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->get_budget: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **budget_id** | [**String**](.md)| Unique identifier for Budgets | + +### Return type + +[**Budgets**](Budgets.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_budgets + +> Budgets get_budgets(xero_tenant_id, opts) + +Retrieve a list of budgets + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +opts = { + i_ds: ['"00000000-0000-0000-0000-000000000000"'], # Array | Filter by BudgetID. Allows you to retrieve a specific individual budget. + + date_to: Date.parse('2013-10-20'), # Date | Filter by start date + + date_from: Date.parse('2013-10-20') # Date | Filter by end date +} + +begin + #Retrieve a list of budgets + result = api_instance.get_budgets(xero_tenant_id, opts) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->get_budgets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **i_ds** | [**Array<String>**](String.md)| Filter by BudgetID. Allows you to retrieve a specific individual budget. | [optional] + **date_to** | **Date**| Filter by start date | [optional] + **date_from** | **Date**| Filter by end date | [optional] + +### Return type + +[**Budgets**](Budgets.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## get_contact > Contacts get_contact(xero_tenant_id, contact_id) @@ -11917,11 +12056,11 @@ Name | Type | Description | Notes - **Accept**: application/json -## get_report_ba_sor_gst +## get_report_balance_sheet -> ReportWithRows get_report_ba_sor_gst(xero_tenant_id, report_id) +> ReportWithRows get_report_balance_sheet(xero_tenant_id, opts) -Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) +Retrieves report for balancesheet ### Example @@ -11949,76 +12088,28 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -report_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Report -begin - #Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs) - result = api_instance.get_report_ba_sor_gst(xero_tenant_id, report_id) - p result -rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_ba_sor_gst: #{e}" -end -``` - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **String**| Xero identifier for Tenant | - **report_id** | **String**| Unique identifier for a Report | - -### Return type - -[**ReportWithRows**](ReportWithRows.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - +opts = { + date: Date.parse('2019-11-01'), # Date | The date of the Balance Sheet report -## get_report_ba_sor_gst_list + periods: 3, # Integer | The number of periods for the Balance Sheet report -> ReportWithRows get_report_ba_sor_gst_list(xero_tenant_id) + timeframe: 'MONTH', # String | The period size to compare to (MONTH, QUARTER, YEAR) -Retrieves report for BAS (only valid for AU orgs) + tracking_option_id1: '00000000-0000-0000-0000-000000000000', # String | The tracking option 1 for the Balance Sheet report -### Example + tracking_option_id2: '00000000-0000-0000-0000-000000000000', # String | The tracking option 2 for the Balance Sheet report -```ruby -# load the gem -require 'xero-ruby' + standard_layout: true, # Boolean | The standard layout boolean for the Balance Sheet report -creds = { - client_id: ENV['CLIENT_ID'], - client_secret: ENV['CLIENT_SECRET'], - redirect_uri: ENV['REDIRECT_URI'], - scopes: ENV['SCOPES'] + payments_only: false # Boolean | return a cash basis for the Balance Sheet report } -xero_client = XeroRuby::ApiClient.new(credentials: creds) - -token_set = fetch_valid_token_set(user) # example - -xero_client.refresh_token_set(token_set) - -# You need to namespace your api method call to one of the following api sets -# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api] -api_instance = xero_client. - - - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant begin - #Retrieves report for BAS (only valid for AU orgs) - result = api_instance.get_report_ba_sor_gst_list(xero_tenant_id) + #Retrieves report for balancesheet + result = api_instance.get_report_balance_sheet(xero_tenant_id, opts) p result rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_ba_sor_gst_list: #{e}" + puts "Exception when calling AccountingApi->get_report_balance_sheet: #{e}" end ``` @@ -12028,6 +12119,13 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | + **date** | **Date**| The date of the Balance Sheet report | [optional] + **periods** | **Integer**| The number of periods for the Balance Sheet report | [optional] + **timeframe** | **String**| The period size to compare to (MONTH, QUARTER, YEAR) | [optional] + **tracking_option_id1** | **String**| The tracking option 1 for the Balance Sheet report | [optional] + **tracking_option_id2** | **String**| The tracking option 2 for the Balance Sheet report | [optional] + **standard_layout** | **Boolean**| The standard layout boolean for the Balance Sheet report | [optional] + **payments_only** | **Boolean**| return a cash basis for the Balance Sheet report | [optional] ### Return type @@ -12043,11 +12141,11 @@ Name | Type | Description | Notes - **Accept**: application/json -## get_report_balance_sheet +## get_report_bank_summary -> ReportWithRows get_report_balance_sheet(xero_tenant_id, opts) +> ReportWithRows get_report_bank_summary(xero_tenant_id, opts) -Retrieves report for balancesheet +Retrieves report for bank summary ### Example @@ -12076,27 +12174,17 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-11-01'), # Date | The date of the Balance Sheet report - - periods: 3, # Integer | The number of periods for the Balance Sheet report - - timeframe: 'MONTH', # String | The period size to compare to (MONTH, QUARTER, YEAR) - - tracking_option_id1: '00000000-0000-0000-0000-000000000000', # String | The tracking option 1 for the Balance Sheet report - - tracking_option_id2: '00000000-0000-0000-0000-000000000000', # String | The tracking option 2 for the Balance Sheet report - - standard_layout: true, # Boolean | The standard layout boolean for the Balance Sheet report + from_date: Date.parse('2013-10-20'), # Date | filter by the from date of the report e.g. 2021-02-01 - payments_only: false # Boolean | return a cash basis for the Balance Sheet report + to_date: Date.parse('2013-10-20') # Date | filter by the to date of the report e.g. 2021-02-28 } begin - #Retrieves report for balancesheet - result = api_instance.get_report_balance_sheet(xero_tenant_id, opts) + #Retrieves report for bank summary + result = api_instance.get_report_bank_summary(xero_tenant_id, opts) p result rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_balance_sheet: #{e}" + puts "Exception when calling AccountingApi->get_report_bank_summary: #{e}" end ``` @@ -12106,13 +12194,8 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **date** | **Date**| The date of the Balance Sheet report | [optional] - **periods** | **Integer**| The number of periods for the Balance Sheet report | [optional] - **timeframe** | **String**| The period size to compare to (MONTH, QUARTER, YEAR) | [optional] - **tracking_option_id1** | **String**| The tracking option 1 for the Balance Sheet report | [optional] - **tracking_option_id2** | **String**| The tracking option 2 for the Balance Sheet report | [optional] - **standard_layout** | **Boolean**| The standard layout boolean for the Balance Sheet report | [optional] - **payments_only** | **Boolean**| return a cash basis for the Balance Sheet report | [optional] + **from_date** | **Date**| filter by the from date of the report e.g. 2021-02-01 | [optional] + **to_date** | **Date**| filter by the to date of the report e.g. 2021-02-28 | [optional] ### Return type @@ -12128,11 +12211,11 @@ Name | Type | Description | Notes - **Accept**: application/json -## get_report_bank_summary +## get_report_budget_summary -> ReportWithRows get_report_bank_summary(xero_tenant_id, opts) +> ReportWithRows get_report_budget_summary(xero_tenant_id, opts) -Retrieves report for bank summary +Retrieves report for budget summary ### Example @@ -12161,17 +12244,19 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant opts = { - from_date: Date.parse('2013-10-20'), # Date | filter by the from date of the report e.g. 2021-02-01 + date: Date.parse('2019-03-31'), # Date | The date for the Bank Summary report e.g. 2018-03-31 - to_date: Date.parse('2013-10-20') # Date | filter by the to date of the report e.g. 2021-02-28 + periods: 2, # Integer | The number of periods to compare (integer between 1 and 12) + + timeframe: 3 # Integer | The period size to compare to (1=month, 3=quarter, 12=year) } begin - #Retrieves report for bank summary - result = api_instance.get_report_bank_summary(xero_tenant_id, opts) + #Retrieves report for budget summary + result = api_instance.get_report_budget_summary(xero_tenant_id, opts) p result rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_bank_summary: #{e}" + puts "Exception when calling AccountingApi->get_report_budget_summary: #{e}" end ``` @@ -12181,8 +12266,9 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **from_date** | **Date**| filter by the from date of the report e.g. 2021-02-01 | [optional] - **to_date** | **Date**| filter by the to date of the report e.g. 2021-02-28 | [optional] + **date** | **Date**| The date for the Bank Summary report e.g. 2018-03-31 | [optional] + **periods** | **Integer**| The number of periods to compare (integer between 1 and 12) | [optional] + **timeframe** | **Integer**| The period size to compare to (1=month, 3=quarter, 12=year) | [optional] ### Return type @@ -12198,11 +12284,11 @@ Name | Type | Description | Notes - **Accept**: application/json -## get_report_budget_summary +## get_report_executive_summary -> ReportWithRows get_report_budget_summary(xero_tenant_id, opts) +> ReportWithRows get_report_executive_summary(xero_tenant_id, opts) -Retrieves report for budget summary +Retrieves report for executive summary ### Example @@ -12231,19 +12317,15 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant opts = { - date: Date.parse('2019-03-31'), # Date | The date for the Bank Summary report e.g. 2018-03-31 - - period: 2, # Integer | The number of periods to compare (integer between 1 and 12) - - timeframe: 3 # Integer | The period size to compare to (1=month, 3=quarter, 12=year) + date: Date.parse('2019-03-31') # Date | The date for the Bank Summary report e.g. 2018-03-31 } begin - #Retrieves report for budget summary - result = api_instance.get_report_budget_summary(xero_tenant_id, opts) + #Retrieves report for executive summary + result = api_instance.get_report_executive_summary(xero_tenant_id, opts) p result rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_budget_summary: #{e}" + puts "Exception when calling AccountingApi->get_report_executive_summary: #{e}" end ``` @@ -12254,8 +12336,6 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **date** | **Date**| The date for the Bank Summary report e.g. 2018-03-31 | [optional] - **period** | **Integer**| The number of periods to compare (integer between 1 and 12) | [optional] - **timeframe** | **Integer**| The period size to compare to (1=month, 3=quarter, 12=year) | [optional] ### Return type @@ -12271,11 +12351,11 @@ Name | Type | Description | Notes - **Accept**: application/json -## get_report_executive_summary +## get_report_from_id -> ReportWithRows get_report_executive_summary(xero_tenant_id, opts) +> ReportWithRows get_report_from_id(xero_tenant_id, report_id) -Retrieves report for executive summary +Retrieves a specific report using a unique ReportID ### Example @@ -12303,16 +12383,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant -opts = { - date: Date.parse('2019-03-31') # Date | The date for the Bank Summary report e.g. 2018-03-31 -} - +report_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Report begin - #Retrieves report for executive summary - result = api_instance.get_report_executive_summary(xero_tenant_id, opts) + #Retrieves a specific report using a unique ReportID + result = api_instance.get_report_from_id(xero_tenant_id, report_id) p result rescue XeroRuby::Accounting::ApiError => e - puts "Exception when calling AccountingApi->get_report_executive_summary: #{e}" + puts "Exception when calling AccountingApi->get_report_from_id: #{e}" end ``` @@ -12322,7 +12399,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | - **date** | **Date**| The date for the Bank Summary report e.g. 2018-03-31 | [optional] + **report_id** | **String**| Unique identifier for a Report | ### Return type @@ -12569,6 +12646,68 @@ Name | Type | Description | Notes - **Accept**: application/json +## get_reports_list + +> ReportWithRows get_reports_list(xero_tenant_id) + +Retrieves a list of the organistaions unique reports that require a uuid to fetch + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +begin + #Retrieves a list of the organistaions unique reports that require a uuid to fetch + result = api_instance.get_reports_list(xero_tenant_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->get_reports_list: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + +### Return type + +[**ReportWithRows**](ReportWithRows.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## get_tax_rates > TaxRates get_tax_rates(xero_tenant_id, opts) diff --git a/docs/accounting/Budget.md b/docs/accounting/Budget.md new file mode 100644 index 00000000..bb00501a --- /dev/null +++ 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 new file mode 100644 index 00000000..12d8ed5a --- /dev/null +++ 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 new file mode 100644 index 00000000..a1ca6ca3 --- /dev/null +++ b/docs/accounting/Budgets.md @@ -0,0 +1,17 @@ +# XeroRuby::Accounting::Budgets + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**budgets** | [**Array<Budget>**](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 index cbd08c8f..9f8eae0d 100644 --- 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 <TaxAmount> is not correct. | [optional] **line_amount** | **BigDecimal** | If you wish to omit either of the <Quantity> or <UnitAmount> 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 = 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 index 2cc678c4..68d39a78 100644 --- 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 index af9c9af9..b5e71fab 100644 --- 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] diff --git a/docs/accounting/index.html b/docs/accounting/index.html index 0d0a8ea0..ec675df2 100644 --- a/docs/accounting/index.html +++ b/docs/accounting/index.html @@ -1773,6 +1773,86 @@ }, "description" : "", "x-isObjectArray" : true +}; + defs["Budget"] = { + "title" : "", + "type" : "object", + "properties" : { + "BudgetID" : { + "type" : "string", + "description" : "Xero identifier", + "format" : "uuid" + }, + "Type" : { + "type" : "string", + "description" : "Type of Budget. OVERALL or TRACKING", + "enum" : [ "OVERALL", "TRACKING" ] + }, + "Description" : { + "maxLength" : 255, + "type" : "string", + "description" : "The Budget description" + }, + "UpdatedDateUTC" : { + "type" : "string", + "description" : "UTC timestamp of last update to budget", + "readOnly" : true, + "example" : "/Date(1573755038314)/", + "x-is-msdate-time" : true + }, + "BudgetLines" : { + "$ref" : "#/components/schemas/BudgetLines" + }, + "Tracking" : { + "$ref" : "#/components/schemas/TrackingCategory" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/budgets/" + } +}; + defs["BudgetLines"] = { + "title" : "", + "type" : "object", + "properties" : { + "Period" : { + "type" : "string", + "description" : "Period the amount applies to (e.g. “2019-08”)", + "x-is-msdate" : true + }, + "Amount" : { + "type" : "integer", + "description" : "LineItem Quantity" + }, + "UnitAmount" : { + "type" : "integer", + "description" : "Budgeted amount" + }, + "Notes" : { + "maxLength" : 255, + "type" : "string", + "description" : "Any footnotes associated with this balance" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/budgets/" + } +}; + defs["Budgets"] = { + "title" : "", + "type" : "object", + "properties" : { + "Budgets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Budget" + } + } + }, + "description" : "", + "x-isObjectArray" : true }; defs["CISOrgSetting"] = { "title" : "", @@ -3370,6 +3450,12 @@ "type" : "string", "description" : "See Accounts" }, + "AccountID" : { + "type" : "string", + "description" : "The associated account ID related to this line item", + "format" : "uuid", + "example" : "00000000-0000-0000-0000-000000000000" + }, "TaxType" : { "type" : "string", "description" : "The tax type from TaxRates" @@ -5005,10 +5091,6 @@ defs["Report"] = { "title" : "", "properties" : { - "ReportID" : { - "type" : "string", - "description" : "See Prepayment Types" - }, "ReportName" : { "type" : "string", "description" : "See Prepayment Types" @@ -5141,7 +5223,7 @@ "properties" : { "ReportID" : { "type" : "string", - "description" : "Report id" + "description" : "ID of the Report" }, "ReportName" : { "type" : "string", @@ -5825,7 +5907,7 @@