xero-ruby 0.1.1

data/docs/Payment.md

@@ -0,0 +1,61 @@
+# XeroRuby::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** | **Float** | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 | [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] 
+**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] 
+**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
+**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::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: null,
+                                 payment_id: null,
+                                 bank_account_number: null,
+                                 particulars: null,
+                                 details: null,
+                                 has_account: null,
+                                 has_validation_errors: null,
+                                 validation_errors: null)
+```
+
+

data/docs/PaymentService.md

@@ -0,0 +1,27 @@
+# XeroRuby::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'
+
+instance = XeroRuby::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/PaymentServices.md

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

data/docs/PaymentTerm.md

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

data/docs/PaymentTermType.md

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

data/docs/Payments.md

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

data/docs/Phone.md

@@ -0,0 +1,23 @@
+# XeroRuby::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'
+
+instance = XeroRuby::Phone.new(phone_type: null,
+                                 phone_number: null,
+                                 phone_area_code: null,
+                                 phone_country_code: null)
+```
+
+

data/docs/Prepayment.md

@@ -0,0 +1,49 @@
+# XeroRuby::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** | **Float** | The subtotal of the prepayment excluding taxes | [optional] 
+**total_tax** | **Float** | The total tax on the prepayment | [optional] 
+**total** | **Float** | The total of the prepayment(subtotal + total tax) | [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** | **Float** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional] 
+**remaining_credit** | **Float** | The remaining credit balance on the prepayment | [optional] 
+**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional] 
+**has_attachments** | **Boolean** | boolean to indicate if a prepayment has an attachment | [optional] 
+**attachments** | [**Array<Attachment>**](Attachment.md) | See Attachments | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::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,
+                                 updated_date_utc: null,
+                                 currency_code: null,
+                                 prepayment_id: null,
+                                 currency_rate: null,
+                                 remaining_credit: null,
+                                 allocations: null,
+                                 has_attachments: null,
+                                 attachments: null)
+```
+
+

data/docs/Prepayments.md

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

data/docs/Purchase.md

@@ -0,0 +1,23 @@
+# XeroRuby::Purchase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**unit_price** | **Float** | 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'
+
+instance = XeroRuby::Purchase.new(unit_price: null,
+                                 account_code: null,
+                                 cogs_account_code: null,
+                                 tax_type: null)
+```
+
+

data/docs/PurchaseOrder.md

@@ -0,0 +1,71 @@
+# XeroRuby::PurchaseOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact** | [**Contact**](Contact.md) |  | 
+**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | 
+**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** | **Float** | The currency rate for a multicurrency purchase order. As no rate can  be specified, the XE.com day rate is used. | [optional] 
+**sub_total** | **Float** | Total of purchase order excluding taxes | [optional] 
+**total_tax** | **Float** | Total tax on purchase order | [optional] 
+**total** | **Float** | Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) | [optional] 
+**total_discount** | **Float** | 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] 
+**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'
+
+instance = XeroRuby::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: null,
+                                 updated_date_utc: null,
+                                 status_attribute_string: null,
+                                 validation_errors: null,
+                                 warnings: null,
+                                 attachments: null)
+```
+
+

data/docs/PurchaseOrders.md

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

data/docs/Receipt.md

@@ -0,0 +1,49 @@
+# XeroRuby::Receipt
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | Date of receipt – YYYY-MM-DD | 
+**contact** | [**Contact**](Contact.md) |  | 
+**line_items** | [**Array<LineItem>**](LineItem.md) |  | 
+**user** | [**User**](User.md) |  | 
+**reference** | **String** | Additional reference number | [optional] 
+**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
+**sub_total** | **Float** | Total of receipt excluding taxes | [optional] 
+**total_tax** | **Float** | Total tax on receipt | [optional] 
+**total** | **Float** | 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] 
+**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] 
+**attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby'
+
+instance = XeroRuby::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: null,
+                                 has_attachments: null,
+                                 url: null,
+                                 validation_errors: null,
+                                 attachments: null)
+```
+
+

data/docs/Receipts.md

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