xero-ruby 2.3.0 → 2.3.1

data/docs/accounting/Organisations.md

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

data/docs/accounting/Overpayment.md

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

data/docs/accounting/Overpayments.md

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

data/docs/accounting/Payment.md

@@ -1,63 +0,0 @@
-# XeroRuby::Accounting::Payment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**invoice** | [**Invoice**](Invoice.md) |  | [optional] 
-**credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
-**prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
-**overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
-**invoice_number** | **String** | Number of invoice or credit note you are applying payment to e.g.INV-4003 | [optional] 
-**credit_note_number** | **String** | Number of invoice or credit note you are applying payment to e.g. INV-4003 | [optional] 
-**account** | [**Account**](Account.md) |  | [optional] 
-**code** | **String** | Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) | [optional] 
-**date** | **Date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
-**currency_rate** | **BigDecimal** | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 | [optional] 
-**amount** | **BigDecimal** | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] 
-**reference** | **String** | An optional description for the payment e.g. Direct Debit | [optional] 
-**is_reconciled** | **Boolean** | An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET | [optional] 
-**status** | **String** | The status of the payment. | [optional] 
-**payment_type** | **String** | See Payment Types. | [optional] 
-**updated_date_utc** | **DateTime** | UTC timestamp of last update to the payment | [optional] 
-**payment_id** | **String** | The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-**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] [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
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Payment.new(invoice: null,
-                                 credit_note: null,
-                                 prepayment: null,
-                                 overpayment: null,
-                                 invoice_number: null,
-                                 credit_note_number: null,
-                                 account: null,
-                                 code: null,
-                                 date: null,
-                                 currency_rate: null,
-                                 amount: null,
-                                 reference: null,
-                                 is_reconciled: null,
-                                 status: null,
-                                 payment_type: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 payment_id: null,
-                                 bank_account_number: null,
-                                 particulars: null,
-                                 details: null,
-                                 has_account: false,
-                                 has_validation_errors: false,
-                                 status_attribute_string: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/PaymentDelete.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::PaymentDelete
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | The status of the payment. | [default to 'DELETED']
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::PaymentDelete.new(status: null)
-```
-
-

data/docs/accounting/PaymentService.md

@@ -1,27 +0,0 @@
-# XeroRuby::Accounting::PaymentService
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payment_service_id** | **String** | Xero identifier | [optional] 
-**payment_service_name** | **String** | Name of payment service | [optional] 
-**payment_service_url** | **String** | The custom payment URL | [optional] 
-**pay_now_text** | **String** | The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card | [optional] 
-**payment_service_type** | **String** | This will always be CUSTOM for payment services created via the API. | [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::PaymentService.new(payment_service_id: null,
-                                 payment_service_name: null,
-                                 payment_service_url: null,
-                                 pay_now_text: null,
-                                 payment_service_type: null,
-                                 validation_errors: null)
-```
-
-

data/docs/accounting/PaymentServices.md

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

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)
-```
-
-