xero-ruby 2.3.1 → 2.4.0

data/docs/accounting/BatchPaymentDetails.md

@@ -0,0 +1,25 @@
+# XeroRuby::Accounting::BatchPaymentDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank_account_number** | **String** | Bank account number for use with Batch Payments | [optional] 
+**bank_account_name** | **String** | Name of bank for use with Batch Payments | [optional] 
+**details** | **String** | (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18 | [optional] 
+**code** | **String** | (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. | [optional] 
+**reference** | **String** | (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::BatchPaymentDetails.new(bank_account_number: 123-456-1111111,
+                                 bank_account_name: ACME Bank,
+                                 details: Hello World,
+                                 code: ABC,
+                                 reference: Foobar)
+```
+
+

data/docs/accounting/BatchPayments.md

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

data/docs/accounting/Bill.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::Bill
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**day** | **Integer** | Day of Month (0-31) | [optional] 
+**type** | [**PaymentTermType**](PaymentTermType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Bill.new(day: null,
+                                 type: null)
+```
+
+

data/docs/accounting/BrandingTheme.md

@@ -0,0 +1,27 @@
+# XeroRuby::Accounting::BrandingTheme
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branding_theme_id** | **String** | Xero identifier | [optional] 
+**name** | **String** | Name of branding theme | [optional] 
+**logo_url** | **String** | The location of the image file used as the logo on this branding theme | [optional] 
+**type** | **String** | Always INVOICE | [optional] 
+**sort_order** | **Integer** | Integer – ranked order of branding theme. The default branding theme has a value of 0 | [optional] 
+**created_date_utc** | **DateTime** | UTC timestamp of creation date of branding theme | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::BrandingTheme.new(branding_theme_id: null,
+                                 name: null,
+                                 logo_url: null,
+                                 type: null,
+                                 sort_order: null,
+                                 created_date_utc: /Date(1573755038314)/)
+```
+
+

data/docs/accounting/BrandingThemes.md

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

data/docs/accounting/CISOrgSetting.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::CISOrgSetting
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cis_contractor_enabled** | **Boolean** | true or false - Boolean that describes if the organisation is a CIS Contractor | [optional] 
+**cis_sub_contractor_enabled** | **Boolean** | true or false - Boolean that describes if the organisation is a CIS SubContractor | [optional] 
+**rate** | **Integer** | CIS Deduction rate for the organisation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::CISOrgSetting.new(cis_contractor_enabled: null,
+                                 cis_sub_contractor_enabled: null,
+                                 rate: null)
+```
+
+

data/docs/accounting/CISSetting.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::CISSetting
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cis_enabled** | **Boolean** | Boolean that describes if the contact is a CIS Subcontractor | [optional] 
+**rate** | **Integer** | CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::CISSetting.new(cis_enabled: null,
+                                 rate: null)
+```
+
+

data/docs/accounting/CISSettings.md

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

data/docs/accounting/Contact.md

@@ -0,0 +1,93 @@
+# XeroRuby::Accounting::Contact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_id** | **String** | Xero identifier | [optional] 
+**contact_number** | **String** | This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero. | [optional] 
+**account_number** | **String** | A user defined account number. This can be updated via the API and the Xero UI (max length = 50) | [optional] 
+**contact_status** | **String** | Current status of a contact – see contact status types | [optional] 
+**name** | **String** | Full name of contact/organisation (max length = 255) | [optional] 
+**first_name** | **String** | First name of contact person (max length = 255) | [optional] 
+**last_name** | **String** | Last name of contact person (max length = 255) | [optional] 
+**email_address** | **String** | Email address of contact person (umlauts not supported) (max length  = 255) | [optional] 
+**skype_user_name** | **String** | Skype user name of contact | [optional] 
+**contact_persons** | [**Array<ContactPerson>**](ContactPerson.md) | See contact persons | [optional] 
+**bank_account_details** | **String** | Bank account number of contact | [optional] 
+**tax_number** | **String** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional] 
+**accounts_receivable_tax_type** | **String** | The tax type from TaxRates | [optional] 
+**accounts_payable_tax_type** | **String** | The tax type from TaxRates | [optional] 
+**addresses** | [**Array<Address>**](Address.md) | Store certain address types for a contact – see address types | [optional] 
+**phones** | [**Array<Phone>**](Phone.md) | Store certain phone types for a contact – see phone types | [optional] 
+**is_supplier** | **Boolean** | true or false – Boolean that describes if a contact that has any AP  invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact. | [optional] 
+**is_customer** | **Boolean** | true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact. | [optional] 
+**default_currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**xero_network_key** | **String** | Store XeroNetworkKey for contacts. | [optional] 
+**sales_default_account_code** | **String** | The default sales account code for contacts | [optional] 
+**purchases_default_account_code** | **String** | The default purchases account code for contacts | [optional] 
+**sales_tracking_categories** | [**Array<SalesTrackingCategory>**](SalesTrackingCategory.md) | The default sales tracking categories for contacts | [optional] 
+**purchases_tracking_categories** | [**Array<SalesTrackingCategory>**](SalesTrackingCategory.md) | The default purchases tracking categories for contacts | [optional] 
+**tracking_category_name** | **String** | The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories | [optional] 
+**tracking_category_option** | **String** | The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories | [optional] 
+**payment_terms** | [**PaymentTerm**](PaymentTerm.md) |  | [optional] 
+**updated_date_utc** | **DateTime** | UTC timestamp of last update to contact | [optional] 
+**contact_groups** | [**Array<ContactGroup>**](ContactGroup.md) | Displays which contact groups a contact is included in | [optional] 
+**website** | **String** | Website address for contact (read only) | [optional] 
+**branding_theme** | [**BrandingTheme**](BrandingTheme.md) |  | [optional] 
+**batch_payments** | [**BatchPaymentDetails**](BatchPaymentDetails.md) |  | [optional] 
+**discount** | **BigDecimal** | The default discount rate for the contact (read only) | [optional] 
+**balances** | [**Balances**](Balances.md) |  | [optional] 
+**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] [default to false]
+**status_attribute_string** | **String** | Status of object | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::Contact.new(contact_id: null,
+                                 contact_number: null,
+                                 account_number: null,
+                                 contact_status: null,
+                                 name: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email_address: null,
+                                 skype_user_name: null,
+                                 contact_persons: null,
+                                 bank_account_details: null,
+                                 tax_number: null,
+                                 accounts_receivable_tax_type: null,
+                                 accounts_payable_tax_type: null,
+                                 addresses: null,
+                                 phones: null,
+                                 is_supplier: null,
+                                 is_customer: null,
+                                 default_currency: null,
+                                 xero_network_key: null,
+                                 sales_default_account_code: null,
+                                 purchases_default_account_code: null,
+                                 sales_tracking_categories: null,
+                                 purchases_tracking_categories: null,
+                                 tracking_category_name: null,
+                                 tracking_category_option: null,
+                                 payment_terms: null,
+                                 updated_date_utc: /Date(1573755038314)/,
+                                 contact_groups: null,
+                                 website: null,
+                                 branding_theme: null,
+                                 batch_payments: null,
+                                 discount: null,
+                                 balances: null,
+                                 attachments: null,
+                                 has_attachments: false,
+                                 validation_errors: null,
+                                 has_validation_errors: false,
+                                 status_attribute_string: null)
+```
+
+

data/docs/accounting/ContactGroup.md

@@ -0,0 +1,23 @@
+# XeroRuby::Accounting::ContactGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The Name of the contact group. Required when creating a new contact  group | [optional] 
+**status** | **String** | The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. | [optional] 
+**contact_group_id** | **String** | The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
+**contacts** | [**Array<Contact>**](Contact.md) | The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ContactGroup.new(name: null,
+                                 status: null,
+                                 contact_group_id: null,
+                                 contacts: null)
+```
+
+

data/docs/accounting/ContactGroups.md

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

data/docs/accounting/ContactPerson.md

@@ -0,0 +1,23 @@
+# XeroRuby::Accounting::ContactPerson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | First name of person | [optional] 
+**last_name** | **String** | Last name of person | [optional] 
+**email_address** | **String** | Email address of person | [optional] 
+**include_in_emails** | **Boolean** | boolean to indicate whether contact should be included on emails with invoices etc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ContactPerson.new(first_name: null,
+                                 last_name: null,
+                                 email_address: null,
+                                 include_in_emails: null)
+```
+
+

data/docs/accounting/Contacts.md

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

data/docs/accounting/ConversionBalances.md

@@ -0,0 +1,21 @@
+# XeroRuby::Accounting::ConversionBalances
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_code** | **String** | The account code for a account | [optional] 
+**balance** | **Float** | The opening balances of the account. Debits are positive, credits are negative values | [optional] 
+**balance_details** | [**Array<BalanceDetails>**](BalanceDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ConversionBalances.new(account_code: null,
+                                 balance: null,
+                                 balance_details: null)
+```
+
+

data/docs/accounting/ConversionDate.md

@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::ConversionDate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **Integer** | The month the organisation starts using Xero. Value is an integer between 1 and 12 | [optional] 
+**year** | **Integer** | The year the organisation starts using Xero. Value is an integer greater than 2006 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::ConversionDate.new(month: 1,
+                                 year: 2020)
+```
+
+

data/docs/accounting/CountryCode.md

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

data/docs/accounting/CreditNote.md

@@ -0,0 +1,69 @@
+# XeroRuby::Accounting::CreditNote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | See Credit Note Types | [optional] 
+**contact** | [**Contact**](Contact.md) |  | [optional] 
+**date** | **Date** | The date the credit note is 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] 
+**due_date** | **Date** | Date invoice is due – YYYY-MM-DD | [optional] 
+**status** | **String** | See Credit Note Status Codes | [optional] 
+**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
+**line_items** | [**Array<LineItem>**](LineItem.md) | See Invoice Line Items | [optional] 
+**sub_total** | **BigDecimal** | The subtotal of the credit note excluding taxes | [optional] 
+**total_tax** | **BigDecimal** | The total tax on the credit note | [optional] 
+**total** | **BigDecimal** | The total of the Credit Note(subtotal + total tax) | [optional] 
+**updated_date_utc** | **DateTime** | UTC timestamp of last update to the credit note | [optional] 
+**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**fully_paid_on_date** | **Date** | Date when credit note was fully paid(UTC format) | [optional] 
+**credit_note_id** | **String** | Xero generated unique identifier | [optional] 
+**credit_note_number** | **String** | ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) | [optional] 
+**reference** | **String** | ACCRECCREDIT only – additional reference number | [optional] 
+**sent_to_contact** | **Boolean** | boolean to indicate if a credit note has been sent to a contact via  the Xero app (currently read only) | [optional] 
+**currency_rate** | **BigDecimal** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional] 
+**remaining_credit** | **BigDecimal** | The remaining credit balance on the Credit Note | [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] 
+**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] [default to false]
+**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::CreditNote.new(type: null,
+                                 contact: null,
+                                 date: null,
+                                 due_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,
+                                 fully_paid_on_date: null,
+                                 credit_note_id: null,
+                                 credit_note_number: null,
+                                 reference: null,
+                                 sent_to_contact: null,
+                                 currency_rate: null,
+                                 remaining_credit: null,
+                                 allocations: null,
+                                 applied_amount: 2.0,
+                                 payments: null,
+                                 branding_theme_id: null,
+                                 status_attribute_string: null,
+                                 has_attachments: false,
+                                 has_errors: false,
+                                 validation_errors: null)
+```
+
+