xero-ruby 2.1.0 → 2.2.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +22 -9
- data/build_notes.md +25 -6
- data/docs/accounting/Account.md +1 -1
- data/docs/accounting/AccountingApi.md +4 -1
- data/docs/accounting/AccountsPayable.md +2 -2
- data/docs/accounting/AccountsReceivable.md +2 -2
- data/docs/accounting/Allocation.md +1 -1
- data/docs/accounting/BankTransaction.md +6 -6
- data/docs/accounting/BankTransfer.md +3 -3
- data/docs/accounting/BatchPayment.md +2 -2
- data/docs/accounting/BrandingTheme.md +1 -1
- data/docs/accounting/Contact.md +2 -2
- data/docs/accounting/CreditNote.md +6 -6
- data/docs/accounting/Employee.md +1 -1
- data/docs/accounting/ExpenseClaim.md +4 -4
- data/docs/accounting/HistoryRecord.md +1 -1
- data/docs/accounting/Invoice.md +12 -10
- data/docs/accounting/Item.md +3 -3
- data/docs/accounting/Journal.md +1 -1
- data/docs/accounting/JournalLine.md +3 -3
- data/docs/accounting/LineItem.md +6 -6
- data/docs/accounting/LinkedTransaction.md +1 -1
- data/docs/accounting/ManualJournal.md +1 -1
- data/docs/accounting/ManualJournalLine.md +2 -2
- data/docs/accounting/Organisation.md +1 -1
- data/docs/accounting/Overpayment.md +6 -6
- data/docs/accounting/Payment.md +3 -3
- data/docs/accounting/Prepayment.md +6 -6
- data/docs/accounting/Purchase.md +1 -1
- data/docs/accounting/PurchaseOrder.md +6 -6
- data/docs/accounting/Quote.md +5 -5
- data/docs/accounting/Receipt.md +4 -4
- data/docs/accounting/RepeatingInvoice.md +3 -3
- data/docs/accounting/Report.md +1 -1
- data/docs/accounting/ReportWithRow.md +1 -1
- data/docs/accounting/TaxComponent.md +1 -1
- data/docs/accounting/TaxRate.md +2 -2
- data/docs/accounting/TenNinetyNineContact.md +13 -13
- data/docs/accounting/TrackingOption.md +3 -3
- data/docs/accounting/User.md +1 -1
- data/docs/assets/Asset.md +3 -3
- data/docs/assets/AssetApi.md +6 -6
- data/docs/assets/BookDepreciationDetail.md +6 -6
- data/docs/assets/BookDepreciationSetting.md +1 -1
- data/docs/projects/Amount.md +1 -1
- data/docs/projects/ProjectCreateOrUpdate.md +1 -1
- data/lib/xero-ruby.rb +1 -1
- data/lib/xero-ruby/api/accounting_api.rb +434 -216
- data/lib/xero-ruby/api/asset_api.rb +19 -13
- data/lib/xero-ruby/api/project_api.rb +27 -14
- data/lib/xero-ruby/api_client.rb +34 -1
- data/lib/xero-ruby/api_error.rb +1 -1
- data/lib/xero-ruby/configuration.rb +2 -2
- data/lib/xero-ruby/models/accounting/account.rb +2 -18
- data/lib/xero-ruby/models/accounting/account_type.rb +1 -1
- data/lib/xero-ruby/models/accounting/accounts.rb +2 -2
- data/lib/xero-ruby/models/accounting/accounts_payable.rb +2 -2
- data/lib/xero-ruby/models/accounting/accounts_receivable.rb +2 -2
- data/lib/xero-ruby/models/accounting/address.rb +2 -2
- data/lib/xero-ruby/models/accounting/allocation.rb +2 -2
- data/lib/xero-ruby/models/accounting/allocations.rb +2 -2
- data/lib/xero-ruby/models/accounting/attachment.rb +2 -2
- data/lib/xero-ruby/models/accounting/attachments.rb +2 -2
- data/lib/xero-ruby/models/accounting/balances.rb +2 -2
- data/lib/xero-ruby/models/accounting/bank_transaction.rb +2 -7
- data/lib/xero-ruby/models/accounting/bank_transactions.rb +2 -2
- data/lib/xero-ruby/models/accounting/bank_transfer.rb +2 -2
- data/lib/xero-ruby/models/accounting/bank_transfers.rb +2 -2
- data/lib/xero-ruby/models/accounting/batch_payment.rb +2 -17
- data/lib/xero-ruby/models/accounting/batch_payment_details.rb +2 -2
- data/lib/xero-ruby/models/accounting/batch_payments.rb +2 -2
- data/lib/xero-ruby/models/accounting/bill.rb +2 -2
- data/lib/xero-ruby/models/accounting/branding_theme.rb +2 -2
- data/lib/xero-ruby/models/accounting/branding_themes.rb +2 -2
- data/lib/xero-ruby/models/accounting/cis_org_setting.rb +2 -2
- data/lib/xero-ruby/models/accounting/cis_setting.rb +2 -2
- data/lib/xero-ruby/models/accounting/cis_settings.rb +2 -2
- data/lib/xero-ruby/models/accounting/contact.rb +2 -2
- data/lib/xero-ruby/models/accounting/contact_group.rb +2 -2
- data/lib/xero-ruby/models/accounting/contact_groups.rb +2 -2
- data/lib/xero-ruby/models/accounting/contact_person.rb +2 -2
- data/lib/xero-ruby/models/accounting/contacts.rb +2 -2
- data/lib/xero-ruby/models/accounting/country_code.rb +1 -1
- data/lib/xero-ruby/models/accounting/credit_note.rb +2 -2
- data/lib/xero-ruby/models/accounting/credit_notes.rb +2 -2
- data/lib/xero-ruby/models/accounting/currencies.rb +2 -2
- data/lib/xero-ruby/models/accounting/currency.rb +2 -2
- data/lib/xero-ruby/models/accounting/currency_code.rb +5 -3
- data/lib/xero-ruby/models/accounting/element.rb +2 -2
- data/lib/xero-ruby/models/accounting/employee.rb +5 -4
- data/lib/xero-ruby/models/accounting/employees.rb +2 -2
- data/lib/xero-ruby/models/accounting/error.rb +2 -2
- data/lib/xero-ruby/models/accounting/expense_claim.rb +2 -2
- data/lib/xero-ruby/models/accounting/expense_claims.rb +2 -2
- data/lib/xero-ruby/models/accounting/external_link.rb +2 -2
- data/lib/xero-ruby/models/accounting/history_record.rb +2 -2
- data/lib/xero-ruby/models/accounting/history_records.rb +2 -2
- data/lib/xero-ruby/models/accounting/invoice.rb +13 -3
- data/lib/xero-ruby/models/accounting/invoice_reminder.rb +2 -2
- data/lib/xero-ruby/models/accounting/invoice_reminders.rb +2 -2
- data/lib/xero-ruby/models/accounting/invoices.rb +2 -2
- data/lib/xero-ruby/models/accounting/item.rb +2 -2
- data/lib/xero-ruby/models/accounting/items.rb +2 -2
- data/lib/xero-ruby/models/accounting/journal.rb +2 -2
- data/lib/xero-ruby/models/accounting/journal_line.rb +2 -2
- data/lib/xero-ruby/models/accounting/journals.rb +2 -2
- data/lib/xero-ruby/models/accounting/line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/accounting/line_item.rb +2 -2
- data/lib/xero-ruby/models/accounting/line_item_tracking.rb +2 -2
- data/lib/xero-ruby/models/accounting/linked_transaction.rb +2 -2
- data/lib/xero-ruby/models/accounting/linked_transactions.rb +2 -2
- data/lib/xero-ruby/models/accounting/manual_journal.rb +2 -2
- data/lib/xero-ruby/models/accounting/manual_journal_line.rb +2 -2
- data/lib/xero-ruby/models/accounting/manual_journals.rb +2 -2
- data/lib/xero-ruby/models/accounting/online_invoice.rb +2 -2
- data/lib/xero-ruby/models/accounting/online_invoices.rb +2 -2
- data/lib/xero-ruby/models/accounting/organisation.rb +2 -4
- data/lib/xero-ruby/models/accounting/organisations.rb +2 -2
- data/lib/xero-ruby/models/accounting/overpayment.rb +2 -2
- data/lib/xero-ruby/models/accounting/overpayments.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment_delete.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment_service.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment_services.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment_term.rb +2 -2
- data/lib/xero-ruby/models/accounting/payment_term_type.rb +1 -1
- data/lib/xero-ruby/models/accounting/payments.rb +2 -2
- data/lib/xero-ruby/models/accounting/phone.rb +2 -2
- data/lib/xero-ruby/models/accounting/prepayment.rb +2 -2
- data/lib/xero-ruby/models/accounting/prepayments.rb +2 -2
- data/lib/xero-ruby/models/accounting/purchase.rb +2 -2
- data/lib/xero-ruby/models/accounting/purchase_order.rb +2 -2
- data/lib/xero-ruby/models/accounting/purchase_orders.rb +2 -2
- data/lib/xero-ruby/models/accounting/quote.rb +2 -2
- data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/accounting/quote_status_codes.rb +1 -1
- data/lib/xero-ruby/models/accounting/quotes.rb +2 -2
- data/lib/xero-ruby/models/accounting/receipt.rb +2 -2
- data/lib/xero-ruby/models/accounting/receipts.rb +2 -2
- data/lib/xero-ruby/models/accounting/repeating_invoice.rb +2 -2
- data/lib/xero-ruby/models/accounting/repeating_invoices.rb +2 -2
- data/lib/xero-ruby/models/accounting/report.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_attribute.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_cell.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_fields.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_row.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_rows.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_with_row.rb +2 -2
- data/lib/xero-ruby/models/accounting/report_with_rows.rb +2 -2
- data/lib/xero-ruby/models/accounting/reports.rb +2 -2
- data/lib/xero-ruby/models/accounting/request_empty.rb +2 -2
- data/lib/xero-ruby/models/accounting/row_type.rb +1 -1
- data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +2 -2
- data/lib/xero-ruby/models/accounting/schedule.rb +2 -2
- data/lib/xero-ruby/models/accounting/tax_component.rb +2 -2
- data/lib/xero-ruby/models/accounting/tax_rate.rb +2 -2
- data/lib/xero-ruby/models/accounting/tax_rates.rb +2 -2
- data/lib/xero-ruby/models/accounting/tax_type.rb +1 -1
- data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +2 -2
- data/lib/xero-ruby/models/accounting/time_zone.rb +2 -1
- data/lib/xero-ruby/models/accounting/tracking_categories.rb +2 -2
- data/lib/xero-ruby/models/accounting/tracking_category.rb +2 -2
- data/lib/xero-ruby/models/accounting/tracking_option.rb +10 -10
- data/lib/xero-ruby/models/accounting/tracking_options.rb +2 -2
- data/lib/xero-ruby/models/accounting/user.rb +2 -2
- data/lib/xero-ruby/models/accounting/users.rb +2 -2
- data/lib/xero-ruby/models/accounting/validation_error.rb +2 -2
- data/lib/xero-ruby/models/assets/asset.rb +2 -2
- data/lib/xero-ruby/models/assets/asset_status.rb +1 -1
- data/lib/xero-ruby/models/assets/asset_status_query_param.rb +1 -1
- data/lib/xero-ruby/models/assets/asset_type.rb +2 -2
- data/lib/xero-ruby/models/assets/assets.rb +2 -2
- data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +2 -2
- data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +2 -2
- data/lib/xero-ruby/models/assets/error.rb +2 -2
- data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +2 -2
- data/lib/xero-ruby/models/assets/pagination.rb +2 -2
- data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +2 -2
- data/lib/xero-ruby/models/assets/setting.rb +2 -2
- data/lib/xero-ruby/models/projects/amount.rb +2 -2
- data/lib/xero-ruby/models/projects/charge_type.rb +1 -1
- data/lib/xero-ruby/models/projects/currency_code.rb +1 -1
- data/lib/xero-ruby/models/projects/error.rb +2 -2
- data/lib/xero-ruby/models/projects/pagination.rb +2 -2
- data/lib/xero-ruby/models/projects/project.rb +2 -2
- data/lib/xero-ruby/models/projects/project_create_or_update.rb +2 -2
- data/lib/xero-ruby/models/projects/project_patch.rb +2 -2
- data/lib/xero-ruby/models/projects/project_status.rb +1 -1
- data/lib/xero-ruby/models/projects/project_user.rb +2 -2
- data/lib/xero-ruby/models/projects/project_users.rb +2 -2
- data/lib/xero-ruby/models/projects/projects.rb +2 -2
- data/lib/xero-ruby/models/projects/task.rb +2 -2
- data/lib/xero-ruby/models/projects/task_create_or_update.rb +2 -2
- data/lib/xero-ruby/models/projects/tasks.rb +2 -2
- data/lib/xero-ruby/models/projects/time_entries.rb +2 -2
- data/lib/xero-ruby/models/projects/time_entry.rb +2 -2
- data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +2 -2
- data/lib/xero-ruby/version.rb +2 -2
- data/xero-ruby-2.2.3.gem +0 -0
- data/xero-ruby.gem +0 -0
- data/xero-ruby.gemspec +2 -2
- metadata +5 -3
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
10
10
|
**account_type** | [**AccountType**](AccountType.md) | | [optional]
|
11
11
|
**account_name** | **String** | See AccountCodes | [optional]
|
12
12
|
**description** | **String** | The description from the source transaction line item. Only returned if populated. | [optional]
|
13
|
-
**net_amount** | **
|
14
|
-
**gross_amount** | **
|
15
|
-
**tax_amount** | **
|
13
|
+
**net_amount** | **BigDecimal** | Net amount of journal line. This will be a positive value for a debit and negative for a credit | [optional]
|
14
|
+
**gross_amount** | **BigDecimal** | Gross amount of journal line (NetAmount + TaxAmount). | [optional]
|
15
|
+
**tax_amount** | **BigDecimal** | Total tax on a journal line | [optional]
|
16
16
|
**tax_type** | **String** | The tax type from TaxRates | [optional]
|
17
17
|
**tax_name** | **String** | see TaxRates | [optional]
|
18
18
|
**tracking_categories** | [**Array<TrackingCategory>**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional]
|
data/docs/accounting/LineItem.md
CHANGED
@@ -6,16 +6,16 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**line_item_id** | **String** | LineItem unique ID | [optional]
|
8
8
|
**description** | **String** | Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character | [optional]
|
9
|
-
**quantity** | **
|
10
|
-
**unit_amount** | **
|
9
|
+
**quantity** | **BigDecimal** | LineItem Quantity | [optional]
|
10
|
+
**unit_amount** | **BigDecimal** | LineItem Unit Amount | [optional]
|
11
11
|
**item_code** | **String** | See Items | [optional]
|
12
12
|
**account_code** | **String** | See Accounts | [optional]
|
13
13
|
**tax_type** | **String** | The tax type from TaxRates | [optional]
|
14
|
-
**tax_amount** | **
|
15
|
-
**line_amount** | **
|
14
|
+
**tax_amount** | **BigDecimal** | 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
|
+
**line_amount** | **BigDecimal** | 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** | **
|
18
|
-
**discount_amount** | **
|
17
|
+
**discount_rate** | **BigDecimal** | 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
|
+
**discount_amount** | **BigDecimal** | 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
19
|
**repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoice | [optional]
|
20
20
|
|
21
21
|
## Code Sample
|
@@ -29,7 +29,7 @@ instance = XeroRuby::Accounting::LinkedTransaction.new(source_transaction_id: nu
|
|
29
29
|
linked_transaction_id: null,
|
30
30
|
status: null,
|
31
31
|
type: null,
|
32
|
-
updated_date_utc:
|
32
|
+
updated_date_utc: /Date(1573755038314)/,
|
33
33
|
source_transaction_type_code: null,
|
34
34
|
validation_errors: null)
|
35
35
|
```
|
@@ -32,7 +32,7 @@ instance = XeroRuby::Accounting::ManualJournal.new(narration: null,
|
|
32
32
|
url: null,
|
33
33
|
show_on_cash_basis_reports: null,
|
34
34
|
has_attachments: false,
|
35
|
-
updated_date_utc:
|
35
|
+
updated_date_utc: /Date(1573755038314)/,
|
36
36
|
manual_journal_id: null,
|
37
37
|
status_attribute_string: ERROR,
|
38
38
|
warnings: null,
|
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**line_amount** | **
|
7
|
+
**line_amount** | **BigDecimal** | total for line. Debits are positive, credits are negative value | [optional]
|
8
8
|
**account_code** | **String** | See Accounts | [optional]
|
9
9
|
**account_id** | **String** | See Accounts | [optional]
|
10
10
|
**description** | **String** | Description for journal line | [optional]
|
11
11
|
**tax_type** | **String** | The tax type from TaxRates | [optional]
|
12
12
|
**tracking** | [**Array<TrackingCategory>**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements. | [optional]
|
13
|
-
**tax_amount** | **
|
13
|
+
**tax_amount** | **BigDecimal** | The calculated tax amount based on the TaxType and LineAmount | [optional]
|
14
14
|
**is_blank** | **Boolean** | is the line blank | [optional]
|
15
15
|
|
16
16
|
## Code Sample
|
@@ -65,7 +65,7 @@ instance = XeroRuby::Accounting::Organisation.new(organisation_id: 8be9db36-3598
|
|
65
65
|
default_purchases_tax: null,
|
66
66
|
period_lock_date: null,
|
67
67
|
end_of_year_lock_date: null,
|
68
|
-
created_date_utc:
|
68
|
+
created_date_utc: /Date(1573755038314)/,
|
69
69
|
timezone: null,
|
70
70
|
organisation_entity_type: null,
|
71
71
|
short_code: null,
|
@@ -10,14 +10,14 @@ Name | Type | Description | Notes
|
|
10
10
|
**status** | **String** | See Overpayment Status Codes | [optional]
|
11
11
|
**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
|
12
12
|
**line_items** | [**Array<LineItem>**](LineItem.md) | See Overpayment Line Items | [optional]
|
13
|
-
**sub_total** | **
|
14
|
-
**total_tax** | **
|
15
|
-
**total** | **
|
13
|
+
**sub_total** | **BigDecimal** | The subtotal of the overpayment excluding taxes | [optional]
|
14
|
+
**total_tax** | **BigDecimal** | The total tax on the overpayment | [optional]
|
15
|
+
**total** | **BigDecimal** | The total of the overpayment (subtotal + total tax) | [optional]
|
16
16
|
**updated_date_utc** | **DateTime** | UTC timestamp of last update to the overpayment | [optional]
|
17
17
|
**currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
|
18
18
|
**overpayment_id** | **String** | Xero generated unique identifier | [optional]
|
19
|
-
**currency_rate** | **
|
20
|
-
**remaining_credit** | **
|
19
|
+
**currency_rate** | **BigDecimal** | The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used | [optional]
|
20
|
+
**remaining_credit** | **BigDecimal** | The remaining credit balance on the overpayment | [optional]
|
21
21
|
**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional]
|
22
22
|
**applied_amount** | **Float** | The amount of applied to an invoice | [optional]
|
23
23
|
**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional]
|
@@ -38,7 +38,7 @@ instance = XeroRuby::Accounting::Overpayment.new(type: null,
|
|
38
38
|
sub_total: null,
|
39
39
|
total_tax: null,
|
40
40
|
total: null,
|
41
|
-
updated_date_utc:
|
41
|
+
updated_date_utc: /Date(1573755038314)/,
|
42
42
|
currency_code: null,
|
43
43
|
overpayment_id: null,
|
44
44
|
currency_rate: null,
|
data/docs/accounting/Payment.md
CHANGED
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
13
13
|
**account** | [**Account**](Account.md) | | [optional]
|
14
14
|
**code** | **String** | Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value) | [optional]
|
15
15
|
**date** | **Date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional]
|
16
|
-
**currency_rate** | **
|
17
|
-
**amount** | **
|
16
|
+
**currency_rate** | **BigDecimal** | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 | [optional]
|
17
|
+
**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]
|
18
18
|
**reference** | **String** | An optional description for the payment e.g. Direct Debit | [optional]
|
19
19
|
**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]
|
20
20
|
**status** | **String** | The status of the payment. | [optional]
|
@@ -49,7 +49,7 @@ instance = XeroRuby::Accounting::Payment.new(invoice: null,
|
|
49
49
|
is_reconciled: null,
|
50
50
|
status: null,
|
51
51
|
payment_type: null,
|
52
|
-
updated_date_utc:
|
52
|
+
updated_date_utc: /Date(1573755038314)/,
|
53
53
|
payment_id: null,
|
54
54
|
bank_account_number: null,
|
55
55
|
particulars: null,
|
@@ -10,15 +10,15 @@ Name | Type | Description | Notes
|
|
10
10
|
**status** | **String** | See Prepayment Status Codes | [optional]
|
11
11
|
**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
|
12
12
|
**line_items** | [**Array<LineItem>**](LineItem.md) | See Prepayment Line Items | [optional]
|
13
|
-
**sub_total** | **
|
14
|
-
**total_tax** | **
|
15
|
-
**total** | **
|
13
|
+
**sub_total** | **BigDecimal** | The subtotal of the prepayment excluding taxes | [optional]
|
14
|
+
**total_tax** | **BigDecimal** | The total tax on the prepayment | [optional]
|
15
|
+
**total** | **BigDecimal** | The total of the prepayment(subtotal + total tax) | [optional]
|
16
16
|
**reference** | **String** | Returns Invoice number field. Reference field isn't available. | [optional]
|
17
17
|
**updated_date_utc** | **DateTime** | UTC timestamp of last update to the prepayment | [optional]
|
18
18
|
**currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
|
19
19
|
**prepayment_id** | **String** | Xero generated unique identifier | [optional]
|
20
|
-
**currency_rate** | **
|
21
|
-
**remaining_credit** | **
|
20
|
+
**currency_rate** | **BigDecimal** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional]
|
21
|
+
**remaining_credit** | **BigDecimal** | The remaining credit balance on the prepayment | [optional]
|
22
22
|
**allocations** | [**Array<Allocation>**](Allocation.md) | See Allocations | [optional]
|
23
23
|
**applied_amount** | **Float** | The amount of applied to an invoice | [optional]
|
24
24
|
**has_attachments** | **Boolean** | boolean to indicate if a prepayment has an attachment | [optional] [default to false]
|
@@ -39,7 +39,7 @@ instance = XeroRuby::Accounting::Prepayment.new(type: null,
|
|
39
39
|
total_tax: null,
|
40
40
|
total: null,
|
41
41
|
reference: null,
|
42
|
-
updated_date_utc:
|
42
|
+
updated_date_utc: /Date(1573755038314)/,
|
43
43
|
currency_code: null,
|
44
44
|
prepayment_id: null,
|
45
45
|
currency_rate: null,
|
data/docs/accounting/Purchase.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**unit_price** | **
|
7
|
+
**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]
|
8
8
|
**account_code** | **String** | Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items | [optional]
|
9
9
|
**cogs_account_code** | **String** | Cost of goods sold account. Only applicable to the purchase details of tracked items. | [optional]
|
10
10
|
**tax_type** | **String** | The tax type from TaxRates | [optional]
|
@@ -21,11 +21,11 @@ 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** | **
|
25
|
-
**sub_total** | **
|
26
|
-
**total_tax** | **
|
27
|
-
**total** | **
|
28
|
-
**total_discount** | **
|
24
|
+
**currency_rate** | **BigDecimal** | The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used. | [optional]
|
25
|
+
**sub_total** | **BigDecimal** | Total of purchase order excluding taxes | [optional]
|
26
|
+
**total_tax** | **BigDecimal** | Total tax on purchase order | [optional]
|
27
|
+
**total** | **BigDecimal** | Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax) | [optional]
|
28
|
+
**total_discount** | **BigDecimal** | Total of discounts applied on the purchase order line items | [optional]
|
29
29
|
**has_attachments** | **Boolean** | boolean to indicate if a purchase order has an attachment | [optional] [default to false]
|
30
30
|
**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional]
|
31
31
|
**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
|
@@ -61,7 +61,7 @@ instance = XeroRuby::Accounting::PurchaseOrder.new(contact: null,
|
|
61
61
|
total: null,
|
62
62
|
total_discount: null,
|
63
63
|
has_attachments: false,
|
64
|
-
updated_date_utc:
|
64
|
+
updated_date_utc: /Date(1573755038314)/,
|
65
65
|
status_attribute_string: null,
|
66
66
|
validation_errors: null,
|
67
67
|
warnings: null,
|
data/docs/accounting/Quote.md
CHANGED
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
|
|
17
17
|
**status** | [**QuoteStatusCodes**](QuoteStatusCodes.md) | | [optional]
|
18
18
|
**currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
|
19
19
|
**currency_rate** | **Float** | The currency rate for a multicurrency quote | [optional]
|
20
|
-
**sub_total** | **
|
21
|
-
**total_tax** | **
|
22
|
-
**total** | **
|
23
|
-
**total_discount** | **
|
20
|
+
**sub_total** | **BigDecimal** | Total of quote excluding taxes. | [optional]
|
21
|
+
**total_tax** | **BigDecimal** | Total tax on quote | [optional]
|
22
|
+
**total** | **BigDecimal** | Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional]
|
23
|
+
**total_discount** | **BigDecimal** | Total of discounts applied on the quote line items | [optional]
|
24
24
|
**title** | **String** | Title text for the quote | [optional]
|
25
25
|
**summary** | **String** | Summary text for the quote | [optional]
|
26
26
|
**branding_theme_id** | **String** | See BrandingThemes | [optional]
|
@@ -54,7 +54,7 @@ instance = XeroRuby::Accounting::Quote.new(quote_id: null,
|
|
54
54
|
title: null,
|
55
55
|
summary: null,
|
56
56
|
branding_theme_id: null,
|
57
|
-
updated_date_utc:
|
57
|
+
updated_date_utc: /Date(1573755038314)/,
|
58
58
|
line_amount_types: null,
|
59
59
|
status_attribute_string: null,
|
60
60
|
validation_errors: null)
|
data/docs/accounting/Receipt.md
CHANGED
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
10
10
|
**user** | [**User**](User.md) | | [optional]
|
11
11
|
**reference** | **String** | Additional reference number | [optional]
|
12
12
|
**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
|
13
|
-
**sub_total** | **
|
14
|
-
**total_tax** | **
|
15
|
-
**total** | **
|
13
|
+
**sub_total** | **BigDecimal** | Total of receipt excluding taxes | [optional]
|
14
|
+
**total_tax** | **BigDecimal** | Total tax on receipt | [optional]
|
15
|
+
**total** | **BigDecimal** | Total of receipt tax inclusive (i.e. SubTotal + TotalTax) | [optional]
|
16
16
|
**receipt_id** | **String** | Xero generated unique identifier for receipt | [optional]
|
17
17
|
**status** | **String** | Current status of receipt – see status types | [optional]
|
18
18
|
**receipt_number** | **String** | Xero generated sequence number for receipt in current claim for a given user | [optional]
|
@@ -40,7 +40,7 @@ instance = XeroRuby::Accounting::Receipt.new(date: null,
|
|
40
40
|
receipt_id: null,
|
41
41
|
status: null,
|
42
42
|
receipt_number: null,
|
43
|
-
updated_date_utc:
|
43
|
+
updated_date_utc: /Date(1573755038314)/,
|
44
44
|
has_attachments: false,
|
45
45
|
url: null,
|
46
46
|
validation_errors: null,
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
13
13
|
**branding_theme_id** | **String** | See BrandingThemes | [optional]
|
14
14
|
**currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
|
15
15
|
**status** | **String** | One of the following - DRAFT or AUTHORISED – See Invoice Status Codes | [optional]
|
16
|
-
**sub_total** | **
|
17
|
-
**total_tax** | **
|
18
|
-
**total** | **
|
16
|
+
**sub_total** | **BigDecimal** | Total of invoice excluding taxes | [optional]
|
17
|
+
**total_tax** | **BigDecimal** | Total tax on invoice | [optional]
|
18
|
+
**total** | **BigDecimal** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax) | [optional]
|
19
19
|
**repeating_invoice_id** | **String** | Xero generated unique identifier for repeating invoice template | [optional]
|
20
20
|
**id** | **String** | Xero generated unique identifier for repeating invoice template | [optional]
|
21
21
|
**has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false]
|
data/docs/accounting/Report.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**name** | **String** | Name of Tax Component | [optional]
|
8
|
-
**rate** | **
|
8
|
+
**rate** | **BigDecimal** | Tax Rate (up to 4dp) | [optional]
|
9
9
|
**is_compound** | **Boolean** | Boolean to describe if Tax rate is compounded. | [optional]
|
10
10
|
**is_non_recoverable** | **Boolean** | Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations | [optional]
|
11
11
|
|
data/docs/accounting/TaxRate.md
CHANGED
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
14
14
|
**can_apply_to_expenses** | **Boolean** | Boolean to describe if tax rate can be used for expense accounts i.e. true,false | [optional]
|
15
15
|
**can_apply_to_liabilities** | **Boolean** | Boolean to describe if tax rate can be used for liability accounts i.e. true,false | [optional]
|
16
16
|
**can_apply_to_revenue** | **Boolean** | Boolean to describe if tax rate can be used for revenue accounts i.e. true,false | [optional]
|
17
|
-
**display_tax_rate** | **
|
18
|
-
**effective_rate** | **
|
17
|
+
**display_tax_rate** | **BigDecimal** | Tax Rate (decimal to 4dp) e.g 12.5000 | [optional]
|
18
|
+
**effective_rate** | **BigDecimal** | Effective Tax Rate (decimal to 4dp) e.g 12.5000 | [optional]
|
19
19
|
|
20
20
|
## Code Sample
|
21
21
|
|
@@ -4,19 +4,19 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**box1** | **
|
8
|
-
**box2** | **
|
9
|
-
**box3** | **
|
10
|
-
**box4** | **
|
11
|
-
**box5** | **
|
12
|
-
**box6** | **
|
13
|
-
**box7** | **
|
14
|
-
**box8** | **
|
15
|
-
**box9** | **
|
16
|
-
**box10** | **
|
17
|
-
**box11** | **
|
18
|
-
**box13** | **
|
19
|
-
**box14** | **
|
7
|
+
**box1** | **BigDecimal** | Box 1 on 1099 Form | [optional]
|
8
|
+
**box2** | **BigDecimal** | Box 2 on 1099 Form | [optional]
|
9
|
+
**box3** | **BigDecimal** | Box 3 on 1099 Form | [optional]
|
10
|
+
**box4** | **BigDecimal** | Box 4 on 1099 Form | [optional]
|
11
|
+
**box5** | **BigDecimal** | Box 5 on 1099 Form | [optional]
|
12
|
+
**box6** | **BigDecimal** | Box 6 on 1099 Form | [optional]
|
13
|
+
**box7** | **BigDecimal** | Box 7 on 1099 Form | [optional]
|
14
|
+
**box8** | **BigDecimal** | Box 8 on 1099 Form | [optional]
|
15
|
+
**box9** | **BigDecimal** | Box 9 on 1099 Form | [optional]
|
16
|
+
**box10** | **BigDecimal** | Box 10 on 1099 Form | [optional]
|
17
|
+
**box11** | **BigDecimal** | Box 11 on 1099 Form | [optional]
|
18
|
+
**box13** | **BigDecimal** | Box 13 on 1099 Form | [optional]
|
19
|
+
**box14** | **BigDecimal** | Box 14 on 1099 Form | [optional]
|
20
20
|
**name** | **String** | Contact name on 1099 Form | [optional]
|
21
21
|
**federal_tax_id_type** | **String** | Contact Fed Tax ID type | [optional]
|
22
22
|
**city** | **String** | Contact city on 1099 Form | [optional]
|
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**tracking_option_id** | **String** | The Xero identifier for a tracking
|
8
|
-
**name** | **String** | The name of the tracking option e.g. Marketing, East (max length =
|
7
|
+
**tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a | [optional]
|
8
|
+
**name** | **String** | The name of the tracking option e.g. Marketing, East (max length = 100) | [optional]
|
9
9
|
**status** | **String** | The status of a tracking option | [optional]
|
10
|
-
**tracking_category_id** | **String** | Filter by a tracking
|
10
|
+
**tracking_category_id** | **String** | Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
data/docs/accounting/User.md
CHANGED
data/docs/assets/Asset.md
CHANGED
@@ -9,15 +9,15 @@ Name | Type | Description | Notes
|
|
9
9
|
**asset_type_id** | **String** | The Xero-generated Id for the asset type | [optional]
|
10
10
|
**asset_number** | **String** | Must be unique. | [optional]
|
11
11
|
**purchase_date** | **Date** | The date the asset was purchased YYYY-MM-DD | [optional]
|
12
|
-
**purchase_price** | **
|
13
|
-
**disposal_price** | **
|
12
|
+
**purchase_price** | **BigDecimal** | The purchase price of the asset | [optional]
|
13
|
+
**disposal_price** | **BigDecimal** | The price the asset was disposed at | [optional]
|
14
14
|
**asset_status** | [**AssetStatus**](AssetStatus.md) | | [optional]
|
15
15
|
**warranty_expiry_date** | **String** | The date the asset’s warranty expires (if needed) YYYY-MM-DD | [optional]
|
16
16
|
**serial_number** | **String** | The asset's serial number | [optional]
|
17
17
|
**book_depreciation_setting** | [**BookDepreciationSetting**](BookDepreciationSetting.md) | | [optional]
|
18
18
|
**book_depreciation_detail** | [**BookDepreciationDetail**](BookDepreciationDetail.md) | | [optional]
|
19
19
|
**can_rollback** | **Boolean** | Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back. | [optional]
|
20
|
-
**accounting_book_value** | **
|
20
|
+
**accounting_book_value** | **BigDecimal** | The accounting value of the asset | [optional]
|
21
21
|
**is_delete_enabled_for_date** | **Boolean** | Boolean to indicate whether delete is enabled | [optional]
|
22
22
|
|
23
23
|
## Code Sample
|
data/docs/assets/AssetApi.md
CHANGED
@@ -48,7 +48,7 @@ api_instance = xero_client.asset_api
|
|
48
48
|
api_instance = xero_client.projects_api
|
49
49
|
|
50
50
|
|
51
|
-
xero_tenant_id = '
|
51
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
52
52
|
asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating
|
53
53
|
begin
|
54
54
|
#adds a fixed asset
|
@@ -116,7 +116,7 @@ api_instance = xero_client.asset_api
|
|
116
116
|
api_instance = xero_client.projects_api
|
117
117
|
|
118
118
|
|
119
|
-
xero_tenant_id = '
|
119
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
120
120
|
opts = {
|
121
121
|
asset_type: { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add
|
122
122
|
}
|
@@ -187,7 +187,7 @@ api_instance = xero_client.asset_api
|
|
187
187
|
api_instance = xero_client.projects_api
|
188
188
|
|
189
189
|
|
190
|
-
xero_tenant_id = '
|
190
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
191
191
|
id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # String | fixed asset id for single object
|
192
192
|
begin
|
193
193
|
#retrieves fixed asset by id
|
@@ -255,7 +255,7 @@ api_instance = xero_client.asset_api
|
|
255
255
|
api_instance = xero_client.projects_api
|
256
256
|
|
257
257
|
|
258
|
-
xero_tenant_id = '
|
258
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
259
259
|
begin
|
260
260
|
#searches fixed asset settings
|
261
261
|
result = api_instance.get_asset_settings(xero_tenant_id)
|
@@ -321,7 +321,7 @@ api_instance = xero_client.asset_api
|
|
321
321
|
api_instance = xero_client.projects_api
|
322
322
|
|
323
323
|
|
324
|
-
xero_tenant_id = '
|
324
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
325
325
|
begin
|
326
326
|
#searches fixed asset types
|
327
327
|
result = api_instance.get_asset_types(xero_tenant_id)
|
@@ -387,7 +387,7 @@ api_instance = xero_client.asset_api
|
|
387
387
|
api_instance = xero_client.projects_api
|
388
388
|
|
389
389
|
|
390
|
-
xero_tenant_id = '
|
390
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
391
391
|
status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
|
392
392
|
opts = {
|
393
393
|
page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
|
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**current_capital_gain** | **
|
8
|
-
**current_gain_loss** | **
|
7
|
+
**current_capital_gain** | **BigDecimal** | When an asset is disposed, this will be the sell price minus the purchase price if a profit was made. | [optional]
|
8
|
+
**current_gain_loss** | **BigDecimal** | When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value. | [optional]
|
9
9
|
**depreciation_start_date** | **Date** | YYYY-MM-DD | [optional]
|
10
|
-
**cost_limit** | **
|
11
|
-
**residual_value** | **
|
12
|
-
**prior_accum_depreciation_amount** | **
|
13
|
-
**current_accum_depreciation_amount** | **
|
10
|
+
**cost_limit** | **BigDecimal** | The value of the asset you want to depreciate, if this is less than the cost of the asset. | [optional]
|
11
|
+
**residual_value** | **BigDecimal** | The value of the asset remaining when you've fully depreciated it. | [optional]
|
12
|
+
**prior_accum_depreciation_amount** | **BigDecimal** | All depreciation prior to the current financial year. | [optional]
|
13
|
+
**current_accum_depreciation_amount** | **BigDecimal** | All depreciation occurring in the current financial year. | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|