xero-ruby 0.1.2 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (269) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +44 -35
  3. data/docs/Account.md +3 -1
  4. data/docs/AccountingApi.md +2667 -2323
  5. data/docs/Attachment.md +2 -2
  6. data/docs/BankTransaction.md +3 -3
  7. data/docs/BrandingTheme.md +4 -0
  8. data/docs/Contact.md +3 -1
  9. data/docs/CreditNote.md +2 -0
  10. data/docs/Element.md +15 -1
  11. data/docs/Employee.md +5 -1
  12. data/docs/Invoice.md +6 -4
  13. data/docs/Item.md +3 -1
  14. data/docs/LineItem.md +4 -4
  15. data/docs/LineItemTracking.md +3 -1
  16. data/docs/LinkedTransaction.md +2 -2
  17. data/docs/ManualJournal.md +3 -1
  18. data/docs/Prepayment.md +2 -0
  19. data/docs/PurchaseOrder.md +3 -3
  20. data/docs/Quote.md +59 -0
  21. data/docs/QuoteLineAmountTypes.md +16 -0
  22. data/docs/QuoteStatusCodes.md +16 -0
  23. data/docs/Quotes.md +17 -0
  24. data/docs/Receipt.md +6 -4
  25. data/docs/ReportWithRow.md +2 -2
  26. data/docs/TaxRate.md +1 -1
  27. data/git_push.sh +1 -1
  28. data/lib/.DS_Store +0 -0
  29. data/lib/xero-ruby/api/accounting_api.rb +1741 -1334
  30. data/lib/xero-ruby/api_client.rb +2 -2
  31. data/lib/xero-ruby/api_error.rb +2 -2
  32. data/lib/xero-ruby/configuration.rb +3 -7
  33. data/lib/xero-ruby/models/account.rb +15 -5
  34. data/lib/xero-ruby/models/account_type.rb +2 -2
  35. data/lib/xero-ruby/models/accounts.rb +2 -2
  36. data/lib/xero-ruby/models/accounts_payable.rb +2 -2
  37. data/lib/xero-ruby/models/accounts_receivable.rb +2 -2
  38. data/lib/xero-ruby/models/address.rb +2 -2
  39. data/lib/xero-ruby/models/allocation.rb +2 -2
  40. data/lib/xero-ruby/models/allocations.rb +2 -2
  41. data/lib/xero-ruby/models/attachment.rb +2 -2
  42. data/lib/xero-ruby/models/attachments.rb +2 -2
  43. data/lib/xero-ruby/models/balances.rb +2 -2
  44. data/lib/xero-ruby/models/bank_transaction.rb +2 -2
  45. data/lib/xero-ruby/models/bank_transactions.rb +2 -2
  46. data/lib/xero-ruby/models/bank_transfer.rb +2 -2
  47. data/lib/xero-ruby/models/bank_transfers.rb +2 -2
  48. data/lib/xero-ruby/models/batch_payment.rb +48 -2
  49. data/lib/xero-ruby/models/batch_payment_details.rb +2 -2
  50. data/lib/xero-ruby/models/batch_payments.rb +2 -2
  51. data/lib/xero-ruby/models/bill.rb +2 -2
  52. data/lib/xero-ruby/models/branding_theme.rb +57 -3
  53. data/lib/xero-ruby/models/branding_themes.rb +2 -2
  54. data/lib/xero-ruby/models/cis_org_setting.rb +2 -2
  55. data/lib/xero-ruby/models/cis_setting.rb +2 -2
  56. data/lib/xero-ruby/models/cis_settings.rb +2 -2
  57. data/lib/xero-ruby/models/contact.rb +16 -6
  58. data/lib/xero-ruby/models/contact_group.rb +2 -2
  59. data/lib/xero-ruby/models/contact_groups.rb +2 -2
  60. data/lib/xero-ruby/models/contact_person.rb +2 -2
  61. data/lib/xero-ruby/models/contacts.rb +2 -2
  62. data/lib/xero-ruby/models/country_code.rb +2 -2
  63. data/lib/xero-ruby/models/credit_note.rb +13 -3
  64. data/lib/xero-ruby/models/credit_notes.rb +2 -2
  65. data/lib/xero-ruby/models/currencies.rb +2 -2
  66. data/lib/xero-ruby/models/currency.rb +2 -2
  67. data/lib/xero-ruby/models/currency_code.rb +2 -2
  68. data/lib/xero-ruby/models/element.rb +70 -6
  69. data/lib/xero-ruby/models/employee.rb +28 -6
  70. data/lib/xero-ruby/models/employees.rb +2 -2
  71. data/lib/xero-ruby/models/error.rb +2 -2
  72. data/lib/xero-ruby/models/expense_claim.rb +4 -4
  73. data/lib/xero-ruby/models/expense_claims.rb +2 -2
  74. data/lib/xero-ruby/models/external_link.rb +2 -2
  75. data/lib/xero-ruby/models/history_record.rb +2 -2
  76. data/lib/xero-ruby/models/history_records.rb +2 -2
  77. data/lib/xero-ruby/models/invoice.rb +20 -23
  78. data/lib/xero-ruby/models/invoice_reminder.rb +2 -2
  79. data/lib/xero-ruby/models/invoice_reminders.rb +2 -2
  80. data/lib/xero-ruby/models/invoices.rb +2 -2
  81. data/lib/xero-ruby/models/item.rb +13 -8
  82. data/lib/xero-ruby/models/items.rb +2 -2
  83. data/lib/xero-ruby/models/journal.rb +2 -2
  84. data/lib/xero-ruby/models/journal_line.rb +2 -2
  85. data/lib/xero-ruby/models/journals.rb +2 -2
  86. data/lib/xero-ruby/models/line_amount_types.rb +2 -2
  87. data/lib/xero-ruby/models/line_item.rb +4 -4
  88. data/lib/xero-ruby/models/line_item_tracking.rb +13 -3
  89. data/lib/xero-ruby/models/linked_transaction.rb +3 -8
  90. data/lib/xero-ruby/models/linked_transactions.rb +2 -2
  91. data/lib/xero-ruby/models/manual_journal.rb +15 -10
  92. data/lib/xero-ruby/models/manual_journal_line.rb +2 -2
  93. data/lib/xero-ruby/models/manual_journals.rb +2 -2
  94. data/lib/xero-ruby/models/online_invoice.rb +2 -2
  95. data/lib/xero-ruby/models/online_invoices.rb +2 -2
  96. data/lib/xero-ruby/models/organisation.rb +8 -8
  97. data/lib/xero-ruby/models/organisations.rb +2 -2
  98. data/lib/xero-ruby/models/overpayment.rb +2 -2
  99. data/lib/xero-ruby/models/overpayments.rb +2 -2
  100. data/lib/xero-ruby/models/payment.rb +2 -2
  101. data/lib/xero-ruby/models/payment_service.rb +2 -2
  102. data/lib/xero-ruby/models/payment_services.rb +2 -2
  103. data/lib/xero-ruby/models/payment_term.rb +2 -2
  104. data/lib/xero-ruby/models/payment_term_type.rb +2 -2
  105. data/lib/xero-ruby/models/payments.rb +2 -2
  106. data/lib/xero-ruby/models/phone.rb +2 -2
  107. data/lib/xero-ruby/models/prepayment.rb +13 -3
  108. data/lib/xero-ruby/models/prepayments.rb +2 -2
  109. data/lib/xero-ruby/models/purchase.rb +2 -2
  110. data/lib/xero-ruby/models/purchase_order.rb +3 -13
  111. data/lib/xero-ruby/models/purchase_orders.rb +2 -2
  112. data/lib/xero-ruby/models/quote.rb +487 -0
  113. data/lib/xero-ruby/models/quote_line_amount_types.rb +38 -0
  114. data/lib/xero-ruby/models/quote_status_codes.rb +40 -0
  115. data/lib/xero-ruby/models/quotes.rb +205 -0
  116. data/lib/xero-ruby/models/receipt.rb +17 -25
  117. data/lib/xero-ruby/models/receipts.rb +2 -2
  118. data/lib/xero-ruby/models/repeating_invoice.rb +4 -4
  119. data/lib/xero-ruby/models/repeating_invoices.rb +2 -2
  120. data/lib/xero-ruby/models/report.rb +2 -2
  121. data/lib/xero-ruby/models/report_attribute.rb +2 -2
  122. data/lib/xero-ruby/models/report_cell.rb +2 -2
  123. data/lib/xero-ruby/models/report_fields.rb +2 -2
  124. data/lib/xero-ruby/models/report_row.rb +2 -2
  125. data/lib/xero-ruby/models/report_rows.rb +2 -2
  126. data/lib/xero-ruby/models/report_with_row.rb +12 -12
  127. data/lib/xero-ruby/models/report_with_rows.rb +2 -2
  128. data/lib/xero-ruby/models/reports.rb +2 -2
  129. data/lib/xero-ruby/models/request_empty.rb +2 -2
  130. data/lib/xero-ruby/models/row_type.rb +2 -2
  131. data/lib/xero-ruby/models/sales_tracking_category.rb +2 -2
  132. data/lib/xero-ruby/models/schedule.rb +2 -2
  133. data/lib/xero-ruby/models/tax_component.rb +2 -2
  134. data/lib/xero-ruby/models/tax_rate.rb +6 -11
  135. data/lib/xero-ruby/models/tax_rates.rb +2 -2
  136. data/lib/xero-ruby/models/tax_type.rb +5 -2
  137. data/lib/xero-ruby/models/ten_nintey_nine_contact.rb +2 -2
  138. data/lib/xero-ruby/models/time_zone.rb +2 -2
  139. data/lib/xero-ruby/models/tracking_categories.rb +2 -2
  140. data/lib/xero-ruby/models/tracking_category.rb +2 -2
  141. data/lib/xero-ruby/models/tracking_option.rb +2 -2
  142. data/lib/xero-ruby/models/tracking_options.rb +2 -2
  143. data/lib/xero-ruby/models/user.rb +2 -2
  144. data/lib/xero-ruby/models/users.rb +2 -2
  145. data/lib/xero-ruby/models/validation_error.rb +2 -2
  146. data/lib/xero-ruby/version.rb +3 -3
  147. data/lib/xero-ruby.rb +6 -2
  148. data/pkg/xero-ruby-0.2.0.gem +0 -0
  149. data/spec/api/accounting_api_spec.rb +304 -209
  150. data/spec/api_client_spec.rb +2 -2
  151. data/spec/configuration_spec.rb +2 -2
  152. data/spec/models/account_spec.rb +9 -3
  153. data/spec/models/account_type_spec.rb +2 -2
  154. data/spec/models/accounts_payable_spec.rb +2 -2
  155. data/spec/models/accounts_receivable_spec.rb +2 -2
  156. data/spec/models/accounts_spec.rb +2 -2
  157. data/spec/models/address_spec.rb +2 -2
  158. data/spec/models/allocation_spec.rb +2 -2
  159. data/spec/models/allocations_spec.rb +2 -2
  160. data/spec/models/attachment_spec.rb +2 -2
  161. data/spec/models/attachments_spec.rb +2 -2
  162. data/spec/models/balances_spec.rb +2 -2
  163. data/spec/models/bank_transaction_spec.rb +2 -2
  164. data/spec/models/bank_transactions_spec.rb +2 -2
  165. data/spec/models/bank_transfer_spec.rb +2 -2
  166. data/spec/models/bank_transfers_spec.rb +2 -2
  167. data/spec/models/batch_payment_details_spec.rb +2 -2
  168. data/spec/models/batch_payment_spec.rb +10 -2
  169. data/spec/models/batch_payments_spec.rb +2 -2
  170. data/spec/models/bill_spec.rb +2 -2
  171. data/spec/models/branding_theme_spec.rb +18 -2
  172. data/spec/models/branding_themes_spec.rb +2 -2
  173. data/spec/models/cis_org_setting_spec.rb +2 -2
  174. data/spec/models/cis_setting_spec.rb +2 -2
  175. data/spec/models/cis_settings_spec.rb +2 -2
  176. data/spec/models/contact_group_spec.rb +2 -2
  177. data/spec/models/contact_groups_spec.rb +2 -2
  178. data/spec/models/contact_person_spec.rb +2 -2
  179. data/spec/models/contact_spec.rb +8 -2
  180. data/spec/models/contacts_spec.rb +2 -2
  181. data/spec/models/country_code_spec.rb +2 -2
  182. data/spec/models/credit_note_spec.rb +8 -2
  183. data/spec/models/credit_notes_spec.rb +2 -2
  184. data/spec/models/currencies_spec.rb +2 -2
  185. data/spec/models/currency_code_spec.rb +2 -2
  186. data/spec/models/currency_spec.rb +2 -2
  187. data/spec/models/element_spec.rb +44 -2
  188. data/spec/models/employee_spec.rb +14 -2
  189. data/spec/models/employees_spec.rb +2 -2
  190. data/spec/models/error_spec.rb +2 -2
  191. data/spec/models/expense_claim_spec.rb +3 -3
  192. data/spec/models/expense_claims_spec.rb +2 -2
  193. data/spec/models/external_link_spec.rb +2 -2
  194. data/spec/models/history_record_spec.rb +2 -2
  195. data/spec/models/history_records_spec.rb +2 -2
  196. data/spec/models/invoice_reminder_spec.rb +2 -2
  197. data/spec/models/invoice_reminders_spec.rb +2 -2
  198. data/spec/models/invoice_spec.rb +9 -3
  199. data/spec/models/invoices_spec.rb +2 -2
  200. data/spec/models/item_spec.rb +8 -2
  201. data/spec/models/items_spec.rb +2 -2
  202. data/spec/models/journal_line_spec.rb +2 -2
  203. data/spec/models/journal_spec.rb +2 -2
  204. data/spec/models/journals_spec.rb +2 -2
  205. data/spec/models/line_amount_types_spec.rb +2 -2
  206. data/spec/models/line_item_spec.rb +2 -2
  207. data/spec/models/line_item_tracking_spec.rb +8 -2
  208. data/spec/models/linked_transaction_spec.rb +2 -2
  209. data/spec/models/linked_transactions_spec.rb +2 -2
  210. data/spec/models/manual_journal_line_spec.rb +2 -2
  211. data/spec/models/manual_journal_spec.rb +9 -3
  212. data/spec/models/manual_journals_spec.rb +2 -2
  213. data/spec/models/online_invoice_spec.rb +2 -2
  214. data/spec/models/online_invoices_spec.rb +2 -2
  215. data/spec/models/organisation_spec.rb +5 -5
  216. data/spec/models/organisations_spec.rb +2 -2
  217. data/spec/models/overpayment_spec.rb +2 -2
  218. data/spec/models/overpayments_spec.rb +2 -2
  219. data/spec/models/payment_service_spec.rb +2 -2
  220. data/spec/models/payment_services_spec.rb +2 -2
  221. data/spec/models/payment_spec.rb +2 -2
  222. data/spec/models/payment_term_spec.rb +2 -2
  223. data/spec/models/payment_term_type_spec.rb +2 -2
  224. data/spec/models/payments_spec.rb +2 -2
  225. data/spec/models/phone_spec.rb +2 -2
  226. data/spec/models/prepayment_spec.rb +8 -2
  227. data/spec/models/prepayments_spec.rb +2 -2
  228. data/spec/models/purchase_order_spec.rb +2 -2
  229. data/spec/models/purchase_orders_spec.rb +2 -2
  230. data/spec/models/purchase_spec.rb +2 -2
  231. data/spec/models/quote_line_amount_types_spec.rb +35 -0
  232. data/spec/models/quote_spec.rb +167 -0
  233. data/spec/models/quote_status_codes_spec.rb +35 -0
  234. data/spec/models/quotes_spec.rb +41 -0
  235. data/spec/models/receipt_spec.rb +9 -3
  236. data/spec/models/receipts_spec.rb +2 -2
  237. data/spec/models/repeating_invoice_spec.rb +3 -3
  238. data/spec/models/repeating_invoices_spec.rb +2 -2
  239. data/spec/models/report_attribute_spec.rb +2 -2
  240. data/spec/models/report_cell_spec.rb +2 -2
  241. data/spec/models/report_fields_spec.rb +2 -2
  242. data/spec/models/report_row_spec.rb +2 -2
  243. data/spec/models/report_rows_spec.rb +2 -2
  244. data/spec/models/report_spec.rb +2 -2
  245. data/spec/models/report_with_row_spec.rb +4 -4
  246. data/spec/models/report_with_rows_spec.rb +2 -2
  247. data/spec/models/reports_spec.rb +2 -2
  248. data/spec/models/request_empty_spec.rb +2 -2
  249. data/spec/models/row_type_spec.rb +2 -2
  250. data/spec/models/sales_tracking_category_spec.rb +2 -2
  251. data/spec/models/schedule_spec.rb +2 -2
  252. data/spec/models/tax_component_spec.rb +2 -2
  253. data/spec/models/tax_rate_spec.rb +4 -4
  254. data/spec/models/tax_rates_spec.rb +2 -2
  255. data/spec/models/tax_type_spec.rb +2 -2
  256. data/spec/models/ten_nintey_nine_contact_spec.rb +2 -2
  257. data/spec/models/time_zone_spec.rb +2 -2
  258. data/spec/models/tracking_categories_spec.rb +2 -2
  259. data/spec/models/tracking_category_spec.rb +2 -2
  260. data/spec/models/tracking_option_spec.rb +2 -2
  261. data/spec/models/tracking_options_spec.rb +2 -2
  262. data/spec/models/user_spec.rb +2 -2
  263. data/spec/models/users_spec.rb +2 -2
  264. data/spec/models/validation_error_spec.rb +2 -2
  265. data/spec/spec_helper.rb +2 -2
  266. data/xero-ruby.gemspec +3 -3
  267. metadata +21 -5
  268. data/Gemfile.lock +0 -79
  269. data/pkg/xero-ruby-0.1.2.gem +0 -0
data/docs/Attachment.md CHANGED
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
16
16
  ```ruby
17
17
  require 'XeroRuby'
18
18
 
19
- instance = XeroRuby::Attachment.new(attachment_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
20
- file_name: sample5.jpg,
19
+ instance = XeroRuby::Attachment.new(attachment_id: 00000000-0000-0000-0000-000000000000,
20
+ file_name: xero-dev.jpg,
21
21
  url: https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg,
22
22
  mime_type: image/jpg,
23
23
  content_length: null,
@@ -47,9 +47,9 @@ instance = XeroRuby::BankTransaction.new(type: null,
47
47
  sub_total: null,
48
48
  total_tax: null,
49
49
  total: null,
50
- bank_transaction_id: null,
51
- prepayment_id: null,
52
- overpayment_id: null,
50
+ bank_transaction_id: 00000000-0000-0000-0000-000000000000,
51
+ prepayment_id: 00000000-0000-0000-0000-000000000000,
52
+ overpayment_id: 00000000-0000-0000-0000-000000000000,
53
53
  updated_date_utc: null,
54
54
  has_attachments: null,
55
55
  status_attribute_string: null,
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branding_theme_id** | **String** | Xero identifier | [optional]
8
8
  **name** | **String** | Name of branding theme | [optional]
9
+ **logo_url** | **String** | The location of the image file used as the logo on this branding theme | [optional]
10
+ **type** | **String** | Always INVOICE | [optional]
9
11
  **sort_order** | **Integer** | Integer – ranked order of branding theme. The default branding theme has a value of 0 | [optional]
10
12
  **created_date_utc** | **DateTime** | UTC timestamp of creation date of branding theme | [optional]
11
13
 
@@ -16,6 +18,8 @@ require 'XeroRuby'
16
18
 
17
19
  instance = XeroRuby::BrandingTheme.new(branding_theme_id: null,
18
20
  name: null,
21
+ logo_url: null,
22
+ type: null,
19
23
  sort_order: null,
20
24
  created_date_utc: null)
21
25
  ```
data/docs/Contact.md CHANGED
@@ -42,6 +42,7 @@ Name | Type | Description | Notes
42
42
  **has_attachments** | **Boolean** | A boolean to indicate if a contact has an attachment | [optional]
43
43
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays validation errors returned from the API | [optional]
44
44
  **has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional]
45
+ **status_attribute_string** | **String** | Status of object | [optional]
45
46
 
46
47
  ## Code Sample
47
48
 
@@ -85,7 +86,8 @@ instance = XeroRuby::Contact.new(contact_id: null,
85
86
  attachments: null,
86
87
  has_attachments: null,
87
88
  validation_errors: null,
88
- has_validation_errors: null)
89
+ has_validation_errors: null,
90
+ status_attribute_string: null)
89
91
  ```
90
92
 
91
93
 
data/docs/CreditNote.md CHANGED
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
26
26
  **payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional]
27
27
  **branding_theme_id** | **String** | See BrandingThemes | [optional]
28
28
  **has_attachments** | **Boolean** | boolean to indicate if a credit note has an attachment | [optional]
29
+ **has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional]
29
30
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
30
31
 
31
32
  ## Code Sample
@@ -55,6 +56,7 @@ instance = XeroRuby::CreditNote.new(type: null,
55
56
  payments: null,
56
57
  branding_theme_id: null,
57
58
  has_attachments: null,
59
+ has_errors: null,
58
60
  validation_errors: null)
59
61
  ```
60
62
 
data/docs/Element.md CHANGED
@@ -5,13 +5,27 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Array of Validation Error message | [optional]
8
+ **batch_payment_id** | **String** | Unique ID for batch payment object with validation error | [optional]
9
+ **bank_transaction_id** | **String** | | [optional]
10
+ **credit_note_id** | **String** | | [optional]
11
+ **contact_id** | **String** | | [optional]
12
+ **invoice_id** | **String** | | [optional]
13
+ **item_id** | **String** | | [optional]
14
+ **purchase_order_id** | **String** | | [optional]
8
15
 
9
16
  ## Code Sample
10
17
 
11
18
  ```ruby
12
19
  require 'XeroRuby'
13
20
 
14
- instance = XeroRuby::Element.new(validation_errors: null)
21
+ instance = XeroRuby::Element.new(validation_errors: null,
22
+ batch_payment_id: null,
23
+ bank_transaction_id: null,
24
+ credit_note_id: null,
25
+ contact_id: null,
26
+ invoice_id: null,
27
+ item_id: null,
28
+ purchase_order_id: null)
15
29
  ```
16
30
 
17
31
 
data/docs/Employee.md CHANGED
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
10
10
  **last_name** | **String** | Last name of an employee (max length = 255) | [optional]
11
11
  **external_link** | [**ExternalLink**](ExternalLink.md) | | [optional]
12
12
  **updated_date_utc** | **DateTime** | | [optional]
13
+ **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
14
+ **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
13
15
 
14
16
  ## Code Sample
15
17
 
@@ -21,7 +23,9 @@ instance = XeroRuby::Employee.new(employee_id: null,
21
23
  first_name: null,
22
24
  last_name: null,
23
25
  external_link: null,
24
- updated_date_utc: null)
26
+ updated_date_utc: null,
27
+ status_attribute_string: ERROR,
28
+ validation_errors: null)
25
29
  ```
26
30
 
27
31
 
data/docs/Invoice.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **type** | **String** | See Invoice Types |
8
- **contact** | [**Contact**](Contact.md) | |
9
- **line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems |
7
+ **type** | **String** | See Invoice Types | [optional]
8
+ **contact** | [**Contact**](Contact.md) | | [optional]
9
+ **line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional]
10
10
  **date** | **Date** | Date invoice 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]
11
11
  **due_date** | **Date** | Date invoice is due – YYYY-MM-DD | [optional]
12
12
  **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
@@ -41,6 +41,7 @@ Name | Type | Description | Notes
41
41
  **has_errors** | **Boolean** | A boolean to indicate if a invoice has an validation errors | [optional]
42
42
  **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
43
43
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
44
+ **warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]
44
45
 
45
46
  ## Code Sample
46
47
 
@@ -83,7 +84,8 @@ instance = XeroRuby::Invoice.new(type: null,
83
84
  attachments: null,
84
85
  has_errors: null,
85
86
  status_attribute_string: null,
86
- validation_errors: null)
87
+ validation_errors: null,
88
+ warnings: null)
87
89
  ```
88
90
 
89
91
 
data/docs/Item.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **code** | **String** | User defined item code (max length = 30) |
8
- **inventory_asset_account_code** | **String** | The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item |
8
+ **inventory_asset_account_code** | **String** | The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item | [optional]
9
9
  **name** | **String** | The name of the item (max length = 50) | [optional]
10
10
  **is_sold** | **Boolean** | Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled. | [optional]
11
11
  **is_purchased** | **Boolean** | Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled. | [optional]
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **quantity_on_hand** | **Float** | The quantity of the item on hand | [optional]
19
19
  **updated_date_utc** | **DateTime** | Last modified date in UTC format | [optional]
20
20
  **item_id** | **String** | The Xero identifier for an Item | [optional]
21
+ **status_attribute_string** | **String** | Status of object | [optional]
21
22
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
22
23
 
23
24
  ## Code Sample
@@ -39,6 +40,7 @@ instance = XeroRuby::Item.new(code: null,
39
40
  quantity_on_hand: null,
40
41
  updated_date_utc: null,
41
42
  item_id: null,
43
+ status_attribute_string: null,
42
44
  validation_errors: null)
43
45
  ```
44
46
 
data/docs/LineItem.md CHANGED
@@ -14,16 +14,16 @@ Name | Type | Description | Notes
14
14
  **tax_amount** | **Float** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional]
15
15
  **line_amount** | **Float** | If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional]
16
16
  **tracking** | [**Array<LineItemTracking>**](LineItemTracking.md) | Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements. | [optional]
17
- **discount_rate** | **String** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
17
+ **discount_rate** | **Float** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
18
18
  **discount_amount** | **Float** | Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. | [optional]
19
- **repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoicee.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
19
+ **repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoice | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
23
23
  ```ruby
24
24
  require 'XeroRuby'
25
25
 
26
- instance = XeroRuby::LineItem.new(line_item_id: null,
26
+ instance = XeroRuby::LineItem.new(line_item_id: 00000000-0000-0000-0000-000000000000,
27
27
  description: null,
28
28
  quantity: null,
29
29
  unit_amount: null,
@@ -35,7 +35,7 @@ instance = XeroRuby::LineItem.new(line_item_id: null,
35
35
  tracking: null,
36
36
  discount_rate: null,
37
37
  discount_amount: null,
38
- repeating_invoice_id: null)
38
+ repeating_invoice_id: 00000000-0000-0000-0000-000000000000)
39
39
  ```
40
40
 
41
41
 
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **tracking_category_id** | **String** | The Xero identifier for a tracking category | [optional]
8
+ **tracking_option_id** | **String** | The Xero identifier for a tracking category option | [optional]
8
9
  **name** | **String** | The name of the tracking category | [optional]
9
10
  **option** | **String** | See Tracking Options | [optional]
10
11
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
13
14
  ```ruby
14
15
  require 'XeroRuby'
15
16
 
16
- instance = XeroRuby::LineItemTracking.new(tracking_category_id: 297c2dc5-cc47-4afd-8ec8-74990b8761e9,
17
+ instance = XeroRuby::LineItemTracking.new(tracking_category_id: 00000000-0000-0000-0000-000000000000,
18
+ tracking_option_id: 00000000-0000-0000-0000-000000000000,
17
19
  name: Region,
18
20
  option: North)
19
21
  ```
@@ -5,11 +5,11 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **source_transaction_id** | **String** | Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice | [optional]
8
- **source_line_item_id** | **String** | The line item identifier from the source transaction. |
8
+ **source_line_item_id** | **String** | The line item identifier from the source transaction. | [optional]
9
9
  **contact_id** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional]
10
10
  **target_transaction_id** | **String** | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice | [optional]
11
11
  **target_line_item_id** | **String** | The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. | [optional]
12
- **linked_transaction_id** | **String** | The Xero identifier for an Linked Transaction e.g. /LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
12
+ **linked_transaction_id** | **String** | The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
13
13
  **status** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional]
14
14
  **type** | **String** | This will always be BILLABLEEXPENSE. More types may be added in future. | [optional]
15
15
  **updated_date_utc** | **DateTime** | The last modified date in UTC format | [optional]
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **narration** | **String** | Description of journal being posted |
8
- **journal_lines** | [**Array<ManualJournalLine>**](ManualJournalLine.md) | See JournalLines |
8
+ **journal_lines** | [**Array<ManualJournalLine>**](ManualJournalLine.md) | See JournalLines | [optional]
9
9
  **date** | **Date** | Date journal was posted – YYYY-MM-DD | [optional]
10
10
  **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
11
11
  **status** | **String** | See Manual Journal Status Codes | [optional]
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **has_attachments** | **Boolean** | Boolean to indicate if a manual journal has an attachment | [optional]
15
15
  **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional]
16
16
  **manual_journal_id** | **String** | The Xero identifier for a Manual Journal | [optional]
17
+ **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
17
18
  **warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]
18
19
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
19
20
  **attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional]
@@ -33,6 +34,7 @@ instance = XeroRuby::ManualJournal.new(narration: null,
33
34
  has_attachments: null,
34
35
  updated_date_utc: null,
35
36
  manual_journal_id: null,
37
+ status_attribute_string: ERROR,
36
38
  warnings: null,
37
39
  validation_errors: null,
38
40
  attachments: null)
data/docs/Prepayment.md CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **sub_total** | **Float** | The subtotal of the prepayment excluding taxes | [optional]
14
14
  **total_tax** | **Float** | The total tax on the prepayment | [optional]
15
15
  **total** | **Float** | The total of the prepayment(subtotal + total tax) | [optional]
16
+ **reference** | **String** | Returns Invoice number field. Reference field isn't available. | [optional]
16
17
  **updated_date_utc** | **DateTime** | UTC timestamp of last update to the prepayment | [optional]
17
18
  **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
18
19
  **prepayment_id** | **String** | Xero generated unique identifier | [optional]
@@ -36,6 +37,7 @@ instance = XeroRuby::Prepayment.new(type: null,
36
37
  sub_total: null,
37
38
  total_tax: null,
38
39
  total: null,
40
+ reference: null,
39
41
  updated_date_utc: null,
40
42
  currency_code: null,
41
43
  prepayment_id: null,
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **contact** | [**Contact**](Contact.md) | |
8
- **line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems |
7
+ **contact** | [**Contact**](Contact.md) | | [optional]
8
+ **line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional]
9
9
  **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]
10
10
  **delivery_date** | **Date** | Date the goods are to be delivered – YYYY-MM-DD | [optional]
11
11
  **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
21
21
  **delivery_instructions** | **String** | A free text feild for instructions (500 characters max) | [optional]
22
22
  **expected_arrival_date** | **Date** | The date the goods are expected to arrive. | [optional]
23
23
  **purchase_order_id** | **String** | Xero generated unique identifier for purchase order | [optional]
24
- **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]
24
+ **currency_rate** | **Float** | The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used. | [optional]
25
25
  **sub_total** | **Float** | Total of purchase order excluding taxes | [optional]
26
26
  **total_tax** | **Float** | Total tax on purchase order | [optional]
27
27
  **total** | **Float** | Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) | [optional]
data/docs/Quote.md ADDED
@@ -0,0 +1,59 @@
1
+ # XeroRuby::Quote
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **quote_id** | **String** | QuoteID GUID is automatically generated and is returned after create or GET. | [optional]
8
+ **quote_number** | **String** | Unique alpha numeric code identifying a quote (Max Length = 255) | [optional]
9
+ **reference** | **String** | Additional reference number | [optional]
10
+ **terms** | **String** | Terms of the quote | [optional]
11
+ **contact** | [**Contact**](Contact.md) | | [optional]
12
+ **line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional]
13
+ **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]
14
+ **date_string** | **String** | Date the quote was issued (YYYY-MM-DD) | [optional]
15
+ **expiry_date** | **Date** | Date the quote expires – YYYY-MM-DD. | [optional]
16
+ **expiry_date_string** | **String** | Date the quote expires – YYYY-MM-DD. | [optional]
17
+ **status** | [**QuoteStatusCodes**](QuoteStatusCodes.md) | | [optional]
18
+ **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
19
+ **currency_rate** | **Float** | The currency rate for a multicurrency quote | [optional]
20
+ **sub_total** | **Float** | Total of quote excluding taxes. | [optional]
21
+ **total_tax** | **Float** | Total tax on quote | [optional]
22
+ **total** | **Float** | Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional]
23
+ **total_discount** | **Float** | Total of discounts applied on the quote line items | [optional]
24
+ **title** | **String** | Title text for the quote | [optional]
25
+ **summary** | **String** | Summary text for the quote | [optional]
26
+ **branding_theme_id** | **String** | See BrandingThemes | [optional]
27
+ **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional]
28
+ **line_amount_types** | [**QuoteLineAmountTypes**](QuoteLineAmountTypes.md) | | [optional]
29
+
30
+ ## Code Sample
31
+
32
+ ```ruby
33
+ require 'XeroRuby'
34
+
35
+ instance = XeroRuby::Quote.new(quote_id: null,
36
+ quote_number: null,
37
+ reference: null,
38
+ terms: null,
39
+ contact: null,
40
+ line_items: null,
41
+ date: null,
42
+ date_string: null,
43
+ expiry_date: null,
44
+ expiry_date_string: null,
45
+ status: null,
46
+ currency_code: null,
47
+ currency_rate: null,
48
+ sub_total: null,
49
+ total_tax: null,
50
+ total: null,
51
+ total_discount: null,
52
+ title: null,
53
+ summary: null,
54
+ branding_theme_id: null,
55
+ updated_date_utc: null,
56
+ line_amount_types: null)
57
+ ```
58
+
59
+
@@ -0,0 +1,16 @@
1
+ # XeroRuby::QuoteLineAmountTypes
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'XeroRuby'
12
+
13
+ instance = XeroRuby::QuoteLineAmountTypes.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,16 @@
1
+ # XeroRuby::QuoteStatusCodes
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'XeroRuby'
12
+
13
+ instance = XeroRuby::QuoteStatusCodes.new()
14
+ ```
15
+
16
+
data/docs/Quotes.md ADDED
@@ -0,0 +1,17 @@
1
+ # XeroRuby::Quotes
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **quotes** | [**Array<Quote>**](Quote.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'XeroRuby'
13
+
14
+ instance = XeroRuby::Quotes.new(quotes: null)
15
+ ```
16
+
17
+
data/docs/Receipt.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **date** | **Date** | Date of receipt – YYYY-MM-DD |
8
- **contact** | [**Contact**](Contact.md) | |
9
- **line_items** | [**Array<LineItem>**](LineItem.md) | |
10
- **user** | [**User**](User.md) | |
7
+ **date** | **Date** | Date of receipt – YYYY-MM-DD | [optional]
8
+ **contact** | [**Contact**](Contact.md) | | [optional]
9
+ **line_items** | [**Array<LineItem>**](LineItem.md) | | [optional]
10
+ **user** | [**User**](User.md) | | [optional]
11
11
  **reference** | **String** | Additional reference number | [optional]
12
12
  **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
13
13
  **sub_total** | **Float** | Total of receipt excluding taxes | [optional]
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
20
20
  **has_attachments** | **Boolean** | boolean to indicate if a receipt has an attachment | [optional]
21
21
  **url** | **String** | URL link to a source document – shown as “Go to [appName]” in the Xero app | [optional]
22
22
  **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
23
+ **warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]
23
24
  **attachments** | [**Array<Attachment>**](Attachment.md) | Displays array of attachments from the API | [optional]
24
25
 
25
26
  ## Code Sample
@@ -43,6 +44,7 @@ instance = XeroRuby::Receipt.new(date: null,
43
44
  has_attachments: null,
44
45
  url: null,
45
46
  validation_errors: null,
47
+ warnings: null,
46
48
  attachments: null)
47
49
  ```
48
50
 
@@ -10,8 +10,8 @@ Name | Type | Description | Notes
10
10
  **report_type** | **String** | The type of report (BalanceSheet,ProfitLoss, etc) | [optional]
11
11
  **report_titles** | **Array<String>** | Report titles array (3 to 4 strings with the report name, orgnisation name and time frame of report) | [optional]
12
12
  **report_date** | **String** | Date of report | [optional]
13
- **updated_date_utc** | **DateTime** | Updated Date | [optional]
14
13
  **rows** | [**Array<ReportRows>**](ReportRows.md) | | [optional]
14
+ **updated_date_utc** | **DateTime** | Updated Date | [optional]
15
15
  **fields** | [**Array<ReportFields>**](ReportFields.md) | | [optional]
16
16
 
17
17
  ## Code Sample
@@ -25,8 +25,8 @@ instance = XeroRuby::ReportWithRow.new(report_id: null,
25
25
  report_type: null,
26
26
  report_titles: null,
27
27
  report_date: null,
28
- updated_date_utc: null,
29
28
  rows: null,
29
+ updated_date_utc: null,
30
30
  fields: null)
31
31
  ```
32
32
 
data/docs/TaxRate.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **tax_type** | **String** | The tax type | [optional]
9
9
  **tax_components** | [**Array<TaxComponent>**](TaxComponent.md) | See TaxComponents | [optional]
10
10
  **status** | **String** | See Status Codes | [optional]
11
- **report_tax_type** | **String** | See ReportTaxTypes |
11
+ **report_tax_type** | **String** | See ReportTaxTypes | [optional]
12
12
  **can_apply_to_assets** | **Boolean** | Boolean to describe if tax rate can be used for asset accounts i.e. true,false | [optional]
13
13
  **can_apply_to_equity** | **Boolean** | Boolean to describe if tax rate can be used for equity accounts i.e true,false | [optional]
14
14
  **can_apply_to_expenses** | **Boolean** | Boolean to describe if tax rate can be used for expense accounts i.e. true,false | [optional]
data/git_push.sh CHANGED
@@ -11,7 +11,7 @@ git_repo_id=$2
11
11
  release_note=$3
12
12
 
13
13
  if [ "$git_user_id" = "" ]; then
14
- git_user_id="Xero API"
14
+ git_user_id="XeroAPI"
15
15
  echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
16
16
  fi
17
17
 
data/lib/.DS_Store ADDED
Binary file