xero-ruby 1.0 → 2.0.3

data/docs/accounting/Allocation.md

@@ -5,8 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **invoice** | [**Invoice**](Invoice.md) |  | 
+**overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
+**prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
+**credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
 **amount** | **Float** | the amount being applied to the invoice | 
 **date** | **Date** | the date the allocation is applied YYYY-MM-DD. | 
+**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] 
 
 ## Code Sample
 
@@ -14,8 +19,13 @@ Name | Type | Description | Notes
 require 'XeroRuby::Accounting'
 
 instance = XeroRuby::Accounting::Allocation.new(invoice: null,
+                                 overpayment: null,
+                                 prepayment: null,
+                                 credit_note: null,
                                  amount: null,
-                                 date: null)
+                                 date: null,
+                                 status_attribute_string: null,
+                                 validation_errors: null)
 ```
 
 

data/docs/accounting/BankTransfer.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **from_bank_account** | [**Account**](Account.md) |  | 
 **to_bank_account** | [**Account**](Account.md) |  | 
-**amount** | **String** | amount of the transaction | 
+**amount** | **Float** | amount of the transaction | 
 **date** | **Date** | The date of the Transfer YYYY-MM-DD | [optional] 
 **bank_transfer_id** | **String** | The identifier of the Bank Transfer | [optional] 
 **currency_rate** | **Float** | The currency rate | [optional] 

data/docs/accounting/BatchPayment.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **date_string** | **String** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
 **date** | **Date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
 **amount** | **Float** | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] 
-**payments** | [**Array<Payment>**](Payment.md) |  | [optional] 
+**payments** | [**Array<Payment>**](Payment.md) | An array of payments | [optional] 
 **type** | **String** | PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) | [optional] 
 **status** | **String** | AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. | [optional] 
 **total_amount** | **String** | The total of the payments that make up the batch (read-only) | [optional] 

data/docs/accounting/Contact.md

@@ -41,7 +41,7 @@ Name | Type | Description | Notes
 **attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
 **has_attachments** | **Boolean** | A boolean to indicate if a contact has an attachment | [optional] [default to false]
 **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays validation errors returned from the API | [optional] 
-**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
+**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] [default to false]
 **status_attribute_string** | **String** | Status of object | [optional] 
 
 ## Code Sample
@@ -86,7 +86,7 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null,
                                  attachments: null,
                                  has_attachments: false,
                                  validation_errors: null,
-                                 has_validation_errors: null,
+                                 has_validation_errors: false,
                                  status_attribute_string: null)
 ```
 

data/docs/accounting/CreditNote.md

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **branding_theme_id** | **String** | See BrandingThemes | [optional] 
 **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
 **has_attachments** | **Boolean** | boolean to indicate if a credit note has an attachment | [optional] [default to false]
-**has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional] 
+**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] 
 
 ## Code Sample
@@ -60,7 +60,7 @@ instance = XeroRuby::Accounting::CreditNote.new(type: null,
                                  branding_theme_id: null,
                                  status_attribute_string: null,
                                  has_attachments: false,
-                                 has_errors: null,
+                                 has_errors: false,
                                  validation_errors: null)
 ```
 

data/docs/accounting/Invoice.md

@@ -38,7 +38,7 @@ Name | Type | Description | Notes
 **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
 **credit_notes** | [**Array<CreditNote>**](CreditNote.md) | Details of credit notes that have been applied to an invoice | [optional] 
 **attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
-**has_errors** | **Boolean** | A boolean to indicate if a invoice has an validation errors | [optional] 
+**has_errors** | **Boolean** | A boolean to indicate if a invoice has an validation errors | [optional] [default to false]
 **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] 
@@ -82,7 +82,7 @@ instance = XeroRuby::Accounting::Invoice.new(type: null,
                                  updated_date_utc: null,
                                  credit_notes: null,
                                  attachments: null,
-                                 has_errors: null,
+                                 has_errors: false,
                                  status_attribute_string: null,
                                  validation_errors: null,
                                  warnings: null)

data/docs/accounting/Journal.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **journal_id** | **String** | Xero identifier | [optional] 
 **journal_date** | **Date** | Date the journal was posted | [optional] 
-**journal_number** | **String** | Xero generated journal number | [optional] 
+**journal_number** | **Integer** | Xero generated journal number | [optional] 
 **created_date_utc** | **DateTime** | Created date UTC format | [optional] 
 **reference** | **String** | reference field for additional indetifying information | [optional] 
 **source_id** | **String** | The identifier for the source transaction (e.g. InvoiceID) | [optional] 

data/docs/accounting/ManualJournalLine.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **line_amount** | **Float** | total for line. Debits are positive, credits are negative value | [optional] 
 **account_code** | **String** | See Accounts | [optional] 
+**account_id** | **String** | See Accounts | [optional] 
 **description** | **String** | Description for journal line | [optional] 
 **tax_type** | **String** | The tax type from TaxRates | [optional] 
 **tracking** | [**Array<TrackingCategory>**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional] 
@@ -19,6 +20,7 @@ require 'XeroRuby::Accounting'
 
 instance = XeroRuby::Accounting::ManualJournalLine.new(line_amount: -2569.0,
                                  account_code: 720,
+                                 account_id: null,
                                  description: Coded incorrectly Office Equipment should be Computer Equipment,
                                  tax_type: null,
                                  tracking: null,

data/docs/accounting/Organisation.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **is_demo_company** | **Boolean** | Boolean to describe if organisation is a demo company. | [optional] 
 **organisation_status** | **String** | Will be set to ACTIVE if you can connect to organisation via the Xero API | [optional] 
 **registration_number** | **String** | Shows for New Zealand, Australian and UK organisations | [optional] 
+**employer_identification_number** | **String** | Shown if set. US Only. | [optional] 
 **tax_number** | **String** | Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global). | [optional] 
 **financial_year_end_day** | **Integer** | Calendar day e.g. 0-31 | [optional] 
 **financial_year_end_month** | **Integer** | Calendar Month e.g. 1-12 | [optional] 
@@ -27,7 +28,7 @@ Name | Type | Description | Notes
 **end_of_year_lock_date** | **Date** | Shown if set. See lock dates | [optional] 
 **created_date_utc** | **DateTime** | Timestamp when the organisation was created in Xero | [optional] 
 **timezone** | [**TimeZone**](TimeZone.md) |  | [optional] 
-**organisation_entity_type** | **String** | Organisation Type | [optional] 
+**organisation_entity_type** | **String** | Organisation Entity Type | [optional] 
 **short_code** | **String** | A unique identifier for the organisation. Potential uses. | [optional] 
 **_class** | **String** | Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM) | [optional] 
 **edition** | **String** | BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing) | [optional] 
@@ -54,6 +55,7 @@ instance = XeroRuby::Accounting::Organisation.new(organisation_id: 8be9db36-3598
                                  is_demo_company: null,
                                  organisation_status: null,
                                  registration_number: null,
+                                 employer_identification_number: null,
                                  tax_number: null,
                                  financial_year_end_day: null,
                                  financial_year_end_month: null,

data/docs/accounting/Payment.md

@@ -24,8 +24,9 @@ Name | Type | Description | Notes
 **bank_account_number** | **String** | The suppliers bank account number the payment is being made to | [optional] 
 **particulars** | **String** | The suppliers bank account number the payment is being made to | [optional] 
 **details** | **String** | The information to appear on the supplier's bank account | [optional] 
-**has_account** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
-**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
+**has_account** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] [default to false]
+**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] [default to false]
+**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] 
 
 ## Code Sample
@@ -53,8 +54,9 @@ instance = XeroRuby::Accounting::Payment.new(invoice: null,
                                  bank_account_number: null,
                                  particulars: null,
                                  details: null,
-                                 has_account: null,
-                                 has_validation_errors: null,
+                                 has_account: false,
+                                 has_validation_errors: false,
+                                 status_attribute_string: null,
                                  validation_errors: null)
 ```
 

data/docs/accounting/Quote.md

@@ -26,6 +26,8 @@ Name | Type | Description | Notes
 **branding_theme_id** | **String** | See BrandingThemes | [optional] 
 **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
 **line_amount_types** | [**QuoteLineAmountTypes**](QuoteLineAmountTypes.md) |  | [optional] 
+**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] 
 
 ## Code Sample
 
@@ -53,7 +55,9 @@ instance = XeroRuby::Accounting::Quote.new(quote_id: null,
                                  summary: null,
                                  branding_theme_id: null,
                                  updated_date_utc: null,
-                                 line_amount_types: null)
+                                 line_amount_types: null,
+                                 status_attribute_string: null,
+                                 validation_errors: null)
 ```
 
 

data/docs/accounting/Report.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **report_title** | **String** | See Prepayment Types | [optional] 
 **report_date** | **String** | Date of report | [optional] 
 **updated_date_utc** | **DateTime** | Updated Date | [optional] 
-**contacts** | [**Array<TenNinteyNineContact>**](TenNinteyNineContact.md) |  | [optional] 
+**contacts** | [**Array<TenNinetyNineContact>**](TenNinetyNineContact.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/accounting/{TenNinteyNineContact.md → TenNinetyNineContact.md}

@@ -1,4 +1,4 @@
-# XeroRuby::Accounting::TenNinteyNineContact
+# XeroRuby::Accounting::TenNinetyNineContact
 
 ## Properties
 
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'XeroRuby::Accounting'
 
-instance = XeroRuby::Accounting::TenNinteyNineContact.new(box1: null,
+instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null,
                                  box2: null,
                                  box3: null,
                                  box4: null,

data/docs/assets/AssetApi.md

@@ -39,14 +39,17 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
+
 
 xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating
-
 begin
   #adds a fixed asset
   result = api_instance.create_asset(xero_tenant_id, asset)
@@ -104,10 +107,14 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
+
 
 xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 opts = {
@@ -171,14 +178,17 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
+
 
 xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # String | fixed asset id for single object
-
 begin
   #retrieves fixed asset by id
   result = api_instance.get_asset_by_id(xero_tenant_id, id)
@@ -236,13 +246,16 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
 
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 
+xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 begin
   #searches fixed asset settings
   result = api_instance.get_asset_settings(xero_tenant_id)
@@ -299,13 +312,16 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
 
-xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 
+xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 begin
   #searches fixed asset types
   result = api_instance.get_asset_types(xero_tenant_id)
@@ -362,18 +378,26 @@ token_set = fetch_valid_token_set(user) # example
 
 xero_client.refresh_token_set(token_set)
 
-# If using the Accounting API
+# depending on the methods you need to use
+# accounting_api
 api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
+# :assets_api
 api_instance = xero_client.asset_api
+# :projects_api
+api_instance = xero_client.projects_api
+
 
 xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
 status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
 opts = {
   page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
+
   page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10.
+
   order_by: 'AssetName', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
+
   sort_direction: 'ASC', # String | ASC or DESC
+
   filter_by: 'Draft' # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
 }
 

data/docs/assets/AssetType.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**asset_type_id** | **String** | Xero generated unique identifier for asset types | 
+**asset_type_id** | **String** | Xero generated unique identifier for asset types | [optional] 
 **asset_type_name** | **String** | The name of the asset type | 
 **fixed_asset_account_id** | **String** | The asset account for fixed assets of this type | [optional] 
 **depreciation_expense_account_id** | **String** | The expense account for the depreciation of fixed assets of this type | [optional] 

data/docs/projects/Amount.md

@@ -0,0 +1,19 @@
+# XeroRuby::Projects::Amount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**value** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Amount.new(currency: null,
+                                 value: 1.0)
+```
+
+

data/docs/projects/ChargeType.md

@@ -0,0 +1,16 @@
+# XeroRuby::Projects::ChargeType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::ChargeType.new()
+```
+
+

data/docs/projects/CurrencyCode.md

@@ -0,0 +1,16 @@
+# XeroRuby::Projects::CurrencyCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::CurrencyCode.new()
+```
+
+

data/docs/projects/Error.md

@@ -0,0 +1,19 @@
+# XeroRuby::Projects::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Exception message | [optional] 
+**model_state** | [**Object**](.md) | Array of Elements of validation Errors | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Error.new(message: null,
+                                 model_state: null)
+```
+
+

data/docs/projects/Pagination.md

@@ -0,0 +1,23 @@
+# XeroRuby::Projects::Pagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **Integer** | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] 
+**page_size** | **Integer** | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] 
+**page_count** | **Integer** | Number of pages available | [optional] 
+**item_count** | **Integer** | Number of items returned | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Pagination.new(page: 1,
+                                 page_size: 10,
+                                 page_count: 1,
+                                 item_count: 2)
+```
+
+