xero-ruby 2.5.0 → 2.5.1

data/docs/accounting/PaymentTerm.md

@@ -1,19 +0,0 @@
-# XeroRuby::Accounting::PaymentTerm
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bills** | [**Bill**](Bill.md) |  | [optional] 
-**sales** | [**Bill**](Bill.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentTerm.new(bills: null,
-                                 sales: null)
-```
-
-

data/docs/accounting/PaymentTermType.md

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

data/docs/accounting/Payments.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Payments
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payments** | [**Array<Payment>**](Payment.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Payments.new(payments: null)
-```
-
-

data/docs/accounting/Phone.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::Phone
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone_type** | **String** |  | [optional] 
-**phone_number** | **String** | max length = 50 | [optional] 
-**phone_area_code** | **String** | max length = 10 | [optional] 
-**phone_country_code** | **String** | max length = 20 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Phone.new(phone_type: null,
-                                 phone_number: null,
-                                 phone_area_code: null,
-                                 phone_country_code: null)
-```
-
-

data/docs/accounting/Prepayment.md

@@ -1,53 +0,0 @@
-# XeroRuby::Accounting::Prepayment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | See Prepayment Types | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**date** | **Date** | The date the prepayment is created YYYY-MM-DD | [optional] 
-**status** | **String** | See Prepayment Status Codes | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See Prepayment Line Items | [optional] 
-**sub_total** | **BigDecimal** | The subtotal of the prepayment excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | The total tax on the prepayment | [optional] 
-**total** | **BigDecimal** | The total of the prepayment(subtotal + total tax) | [optional] 
-**reference** | **String** | Returns Invoice number field. Reference field isn't available. | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the prepayment | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**prepayment_id** | **String** | Xero generated unique identifier | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional] 
-**remaining_credit** | **BigDecimal** | The remaining credit balance on the prepayment | [optional] 
-**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional] 
-**applied_amount** | **Float** | The amount of applied to an invoice | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a prepayment has an attachment | [optional] [default to false]
-**attachments** | [**Array<Attachment>**](Attachment.md) | See Attachments | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Prepayment.new(type: null,
-                                 contact: null,
-                                 date: null,
-                                 status: null,
-                                 line_amount_types: null,
-                                 line_items: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 reference: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 currency_code: null,
-                                 prepayment_id: null,
-                                 currency_rate: null,
-                                 remaining_credit: null,
-                                 allocations: null,
-                                 applied_amount: 2.0,
-                                 has_attachments: false,
-                                 attachments: null)
-```
-
-

data/docs/accounting/Prepayments.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Prepayments
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**prepayments** | [**Array<Prepayment>**](Prepayment.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Prepayments.new(prepayments: null)
-```
-
-

data/docs/accounting/Purchase.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::Purchase
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**unit_price** | **BigDecimal** | Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request. | [optional] 
-**account_code** | **String** | Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items | [optional] 
-**cogs_account_code** | **String** | Cost of goods sold account. Only applicable to the purchase details of tracked items. | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Purchase.new(unit_price: null,
-                                 account_code: null,
-                                 cogs_account_code: null,
-                                 tax_type: null)
-```
-
-

data/docs/accounting/PurchaseOrder.md

@@ -1,71 +0,0 @@
-# XeroRuby::Accounting::PurchaseOrder
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional] 
-**date** | **Date** | Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation | [optional] 
-**delivery_date** | **Date** | Date the goods are to be delivered – YYYY-MM-DD | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**purchase_order_number** | **String** | Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings) | [optional] 
-**reference** | **String** | Additional reference number | [optional] 
-**branding_theme_id** | **String** | See BrandingThemes | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**status** | **String** | See Purchase Order Status Codes | [optional] 
-**sent_to_contact** | **Boolean** | Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed | [optional] 
-**delivery_address** | **String** | The address the goods are to be delivered to | [optional] 
-**attention_to** | **String** | The person that the delivery is going to | [optional] 
-**telephone** | **String** | The phone number for the person accepting the delivery | [optional] 
-**delivery_instructions** | **String** | A free text feild for instructions (500 characters max) | [optional] 
-**expected_arrival_date** | **Date** | The date the goods are expected to arrive. | [optional] 
-**purchase_order_id** | **String** | Xero generated unique identifier for purchase order | [optional] 
-**currency_rate** | **BigDecimal** | The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used. | [optional] 
-**sub_total** | **BigDecimal** | Total of purchase order excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | Total tax on purchase order | [optional] 
-**total** | **BigDecimal** | Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) | [optional] 
-**total_discount** | **BigDecimal** | Total of discounts applied on the purchase order line items | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a purchase order has an attachment | [optional] [default to false]
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [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] 
-**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional] 
-**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PurchaseOrder.new(contact: null,
-                                 line_items: null,
-                                 date: null,
-                                 delivery_date: null,
-                                 line_amount_types: null,
-                                 purchase_order_number: null,
-                                 reference: null,
-                                 branding_theme_id: null,
-                                 currency_code: null,
-                                 status: null,
-                                 sent_to_contact: null,
-                                 delivery_address: null,
-                                 attention_to: null,
-                                 telephone: null,
-                                 delivery_instructions: null,
-                                 expected_arrival_date: null,
-                                 purchase_order_id: null,
-                                 currency_rate: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 total_discount: null,
-                                 has_attachments: false,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 status_attribute_string: null,
-                                 validation_errors: null,
-                                 warnings: null,
-                                 attachments: null)
-```
-
-

data/docs/accounting/PurchaseOrders.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::PurchaseOrders
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**purchase_orders** | [**Array<PurchaseOrder>**](PurchaseOrder.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PurchaseOrders.new(purchase_orders: null)
-```
-
-

data/docs/accounting/Quote.md

@@ -1,63 +0,0 @@
-# XeroRuby::Accounting::Quote
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quote_id** | **String** | QuoteID GUID is automatically generated and is returned after create or GET. | [optional] 
-**quote_number** | **String** | Unique alpha numeric code identifying a quote (Max Length = 255) | [optional] 
-**reference** | **String** | Additional reference number | [optional] 
-**terms** | **String** | Terms of the quote | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional] 
-**date** | **Date** | Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation | [optional] 
-**date_string** | **String** | Date the quote was issued (YYYY-MM-DD) | [optional] 
-**expiry_date** | **Date** | Date the quote expires – YYYY-MM-DD. | [optional] 
-**expiry_date_string** | **String** | Date the quote expires – YYYY-MM-DD. | [optional] 
-**status** | [**QuoteStatusCodes**](QuoteStatusCodes.md) |  | [optional] 
-**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**currency_rate** | **Float** | The currency rate for a multicurrency quote | [optional] 
-**sub_total** | **BigDecimal** | Total of quote excluding taxes. | [optional] 
-**total_tax** | **BigDecimal** | Total tax on quote | [optional] 
-**total** | **BigDecimal** | Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional] 
-**total_discount** | **BigDecimal** | Total of discounts applied on the quote line items | [optional] 
-**title** | **String** | Title text for the quote | [optional] 
-**summary** | **String** | Summary text for the quote | [optional] 
-**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
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Quote.new(quote_id: null,
-                                 quote_number: null,
-                                 reference: null,
-                                 terms: null,
-                                 contact: null,
-                                 line_items: null,
-                                 date: null,
-                                 date_string: null,
-                                 expiry_date: null,
-                                 expiry_date_string: null,
-                                 status: null,
-                                 currency_code: null,
-                                 currency_rate: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 total_discount: null,
-                                 title: null,
-                                 summary: null,
-                                 branding_theme_id: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 line_amount_types: null,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/QuoteLineAmountTypes.md

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

data/docs/accounting/QuoteStatusCodes.md

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

data/docs/accounting/Quotes.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Quotes
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quotes** | [**Array<Quote>**](Quote.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Quotes.new(quotes: null)
-```
-
-

data/docs/accounting/Receipt.md

@@ -1,51 +0,0 @@
-# XeroRuby::Accounting::Receipt
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**date** | **Date** | Date of receipt – YYYY-MM-DD | [optional] 
-**contact** | [**Contact**](Contact.md) |  | [optional] 
-**line_items** | [**Array<LineItem>**](LineItem.md) |  | [optional] 
-**user** | [**User**](User.md) |  | [optional] 
-**reference** | **String** | Additional reference number | [optional] 
-**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**sub_total** | **BigDecimal** | Total of receipt excluding taxes | [optional] 
-**total_tax** | **BigDecimal** | Total tax on receipt | [optional] 
-**total** | **BigDecimal** | Total of receipt tax inclusive (i.e. SubTotal + TotalTax) | [optional] 
-**receipt_id** | **String** | Xero generated unique identifier for receipt | [optional] 
-**status** | **String** | Current status of receipt – see status types | [optional] 
-**receipt_number** | **String** | Xero generated sequence number for receipt in current claim for a given user | [optional] 
-**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**has_attachments** | **Boolean** | boolean to indicate if a receipt has an attachment | [optional] [default to false]
-**url** | **String** | URL link to a source document – shown as “Go to [appName]” in the Xero app | [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] 
-**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Receipt.new(date: null,
-                                 contact: null,
-                                 line_items: null,
-                                 user: null,
-                                 reference: null,
-                                 line_amount_types: null,
-                                 sub_total: null,
-                                 total_tax: null,
-                                 total: null,
-                                 receipt_id: null,
-                                 status: null,
-                                 receipt_number: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 has_attachments: false,
-                                 url: null,
-                                 validation_errors: null,
-                                 warnings: null,
-                                 attachments: null)
-```
-
-

data/docs/accounting/Receipts.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Receipts
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**receipts** | [**Array<Receipt>**](Receipt.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Receipts.new(receipts: null)
-```
-
-