Merge pull request #58 from XeroAPI/accounting-date-as-string

Fix docs for BigDecimal
XeroAPI · Aug 27, 2020 · 0e7c886 · 0e7c886
2 parents 9cb7d87 + 25aed46
commit 0e7c886
Show file tree

Hide file tree

Showing 194 changed files with 282 additions and 286 deletions.
diff --git a/docs/accounting/Account.md b/docs/accounting/Account.md
@@ -47,7 +47,7 @@ instance = XeroRuby::Accounting::Account.new(code: 4400,
                                  reporting_code: null,
                                  reporting_code_name: null,
                                  has_attachments: false,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  add_to_watchlist: null,
                                  validation_errors: null)
 ```

diff --git a/docs/accounting/AccountsPayable.md b/docs/accounting/AccountsPayable.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**outstanding** | **Float** |  | [optional] 
-**overdue** | **Float** |  | [optional] 
+**outstanding** | **BigDecimal** |  | [optional] 
+**overdue** | **BigDecimal** |  | [optional] 
 
 ## Code Sample
 

diff --git a/docs/accounting/AccountsReceivable.md b/docs/accounting/AccountsReceivable.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**outstanding** | **Float** |  | [optional] 
-**overdue** | **Float** |  | [optional] 
+**outstanding** | **BigDecimal** |  | [optional] 
+**overdue** | **BigDecimal** |  | [optional] 
 
 ## Code Sample
 

diff --git a/docs/accounting/Allocation.md b/docs/accounting/Allocation.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
 **prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
 **credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
-**amount** | **Float** | the amount being applied to the invoice | 
+**amount** | **BigDecimal** | the amount being applied to the invoice | 
 **date** | **Date** | the date the allocation is applied YYYY-MM-DD. | 
 **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
 **validation_errors** | [**Array&lt;ValidationError&gt;**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 

diff --git a/docs/accounting/BankTransaction.md b/docs/accounting/BankTransaction.md
@@ -5,20 +5,20 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | See Bank Transaction Types | 
-**contact** | [**Contact**](Contact.md) |  | 
+**contact** | [**Contact**](Contact.md) |  | [optional] 
 **line_items** | [**Array&lt;LineItem&gt;**](LineItem.md) | See LineItems | 
 **bank_account** | [**Account**](Account.md) |  | 
 **is_reconciled** | **Boolean** | Boolean to show if transaction is reconciled | [optional] 
 **date** | **Date** | Date of transaction – YYYY-MM-DD | [optional] 
 **reference** | **String** | Reference for the transaction. Only supported for SPEND and RECEIVE transactions. | [optional] 
 **currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**currency_rate** | **Float** | Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. | [optional] 
+**currency_rate** | **BigDecimal** | Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments. | [optional] 
 **url** | **String** | URL link to a source document – shown as “Go to App Name” | [optional] 
 **status** | **String** | See Bank Transaction Status Codes | [optional] 
 **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
-**sub_total** | **Float** | Total of bank transaction excluding taxes | [optional] 
-**total_tax** | **Float** | Total tax on bank transaction | [optional] 
-**total** | **Float** | Total of bank transaction tax inclusive | [optional] 
+**sub_total** | **BigDecimal** | Total of bank transaction excluding taxes | [optional] 
+**total_tax** | **BigDecimal** | Total tax on bank transaction | [optional] 
+**total** | **BigDecimal** | Total of bank transaction tax inclusive | [optional] 
 **bank_transaction_id** | **String** | Xero generated unique identifier for bank transaction | [optional] 
 **prepayment_id** | **String** | Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT | [optional] 
 **overpayment_id** | **String** | Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT | [optional] 
@@ -50,7 +50,7 @@ instance = XeroRuby::Accounting::BankTransaction.new(type: null,
                                  bank_transaction_id: 00000000-0000-0000-0000-000000000000,
                                  prepayment_id: 00000000-0000-0000-0000-000000000000,
                                  overpayment_id: 00000000-0000-0000-0000-000000000000,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  has_attachments: false,
                                  status_attribute_string: null,
                                  validation_errors: null)

diff --git a/docs/accounting/BankTransfer.md b/docs/accounting/BankTransfer.md
@@ -6,10 +6,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **from_bank_account** | [**Account**](Account.md) |  | 
 **to_bank_account** | [**Account**](Account.md) |  | 
-**amount** | **Float** | amount of the transaction | 
+**amount** | **BigDecimal** | amount of the transaction | 
 **date** | **Date** | The date of the Transfer YYYY-MM-DD | [optional] 
 **bank_transfer_id** | **String** | The identifier of the Bank Transfer | [optional] 
-**currency_rate** | **Float** | The currency rate | [optional] 
+**currency_rate** | **BigDecimal** | The currency rate | [optional] 
 **from_bank_transaction_id** | **String** | The Bank Transaction ID for the source account | [optional] 
 **to_bank_transaction_id** | **String** | The Bank Transaction ID for the destination account | [optional] 
 **has_attachments** | **Boolean** | Boolean to indicate if a Bank Transfer has an attachment | [optional] [default to false]
@@ -30,7 +30,7 @@ instance = XeroRuby::Accounting::BankTransfer.new(from_bank_account: null,
                                  from_bank_transaction_id: null,
                                  to_bank_transaction_id: null,
                                  has_attachments: false,
-                                 created_date_utc: null,
+                                 created_date_utc: /Date(1573755038314)/,
                                  validation_errors: null)
 ```
 

diff --git a/docs/accounting/BatchPayment.md b/docs/accounting/BatchPayment.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **batch_payment_id** | **String** | The Xero generated unique identifier for the bank transaction (read-only) | [optional] 
 **date_string** | **String** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
 **date** | **Date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
-**amount** | **Float** | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] 
+**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] 
 **payments** | [**Array&lt;Payment&gt;**](Payment.md) | An array of payments | [optional] 
 **type** | **String** | PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only) | [optional] 
 **status** | **String** | AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API. | [optional] 
@@ -40,7 +40,7 @@ instance = XeroRuby::Accounting::BatchPayment.new(account: null,
                                  type: null,
                                  status: null,
                                  total_amount: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  is_reconciled: null)
 ```
 

diff --git a/docs/accounting/BrandingTheme.md b/docs/accounting/BrandingTheme.md
@@ -21,7 +21,7 @@ instance = XeroRuby::Accounting::BrandingTheme.new(branding_theme_id: null,
                                  logo_url: null,
                                  type: null,
                                  sort_order: null,
-                                 created_date_utc: null)
+                                 created_date_utc: /Date(1573755038314)/)
 ```
 
 
diff --git a/docs/accounting/Contact.md b/docs/accounting/Contact.md
@@ -36,7 +36,7 @@ Name | Type | Description | Notes
 **website** | **String** | Website address for contact (read only) | [optional] 
 **branding_theme** | [**BrandingTheme**](BrandingTheme.md) |  | [optional] 
 **batch_payments** | [**BatchPaymentDetails**](BatchPaymentDetails.md) |  | [optional] 
-**discount** | **Float** | The default discount rate for the contact (read only) | [optional] 
+**discount** | **BigDecimal** | The default discount rate for the contact (read only) | [optional] 
 **balances** | [**Balances**](Balances.md) |  | [optional] 
 **attachments** | [**Array&lt;Attachment&gt;**](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]
@@ -76,7 +76,7 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null,
                                  tracking_category_name: null,
                                  tracking_category_option: null,
                                  payment_terms: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  contact_groups: null,
                                  website: null,
                                  branding_theme: null,

diff --git a/docs/accounting/CreditNote.md b/docs/accounting/CreditNote.md
@@ -10,18 +10,18 @@ Name | Type | Description | Notes
 **status** | **String** | See Credit Note Status Codes | [optional] 
 **line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) |  | [optional] 
 **line_items** | [**Array&lt;LineItem&gt;**](LineItem.md) | See Invoice Line Items | [optional] 
-**sub_total** | **Float** | The subtotal of the credit note excluding taxes | [optional] 
-**total_tax** | **Float** | The total tax on the credit note | [optional] 
-**total** | **Float** | The total of the Credit Note(subtotal + total tax) | [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** | **Float** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional] 
-**remaining_credit** | **Float** | The remaining credit balance on the Credit Note | [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&lt;Allocation&gt;**](Allocation.md) | See Allocations | [optional] 
 **applied_amount** | **Float** | The amount of applied to an invoice | [optional] 
 **payments** | [**Array&lt;Payment&gt;**](Payment.md) | See Payments | [optional] 
@@ -45,7 +45,7 @@ instance = XeroRuby::Accounting::CreditNote.new(type: null,
                                  sub_total: null,
                                  total_tax: null,
                                  total: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  currency_code: null,
                                  fully_paid_on_date: null,
                                  credit_note_id: null,

diff --git a/docs/accounting/Employee.md b/docs/accounting/Employee.md
@@ -23,7 +23,7 @@ instance = XeroRuby::Accounting::Employee.new(employee_id: null,
                                  first_name: null,
                                  last_name: null,
                                  external_link: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  status_attribute_string: ERROR,
                                  validation_errors: null)
 ```

diff --git a/docs/accounting/ExpenseClaim.md b/docs/accounting/ExpenseClaim.md
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 **user** | [**User**](User.md) |  | [optional] 
 **receipts** | [**Array&lt;Receipt&gt;**](Receipt.md) |  | [optional] 
 **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
-**total** | **Float** | The total of an expense claim being paid | [optional] 
-**amount_due** | **Float** | The amount due to be paid for an expense claim | [optional] 
-**amount_paid** | **Float** | The amount still to pay for an expense claim | [optional] 
+**total** | **BigDecimal** | The total of an expense claim being paid | [optional] 
+**amount_due** | **BigDecimal** | The amount due to be paid for an expense claim | [optional] 
+**amount_paid** | **BigDecimal** | The amount still to pay for an expense claim | [optional] 
 **payment_due_date** | **Date** | The date when the expense claim is due to be paid YYYY-MM-DD | [optional] 
 **reporting_date** | **Date** | The date the expense claim will be reported in Xero YYYY-MM-DD | [optional] 
 **receipt_id** | **String** | The Xero identifier for the Receipt e.g.  e59a2c7f-1306-4078-a0f3-73537afcbba9 | [optional] 
@@ -27,7 +27,7 @@ instance = XeroRuby::Accounting::ExpenseClaim.new(expense_claim_id: null,
                                  payments: null,
                                  user: null,
                                  receipts: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  total: null,
                                  amount_due: null,
                                  amount_paid: null,

diff --git a/docs/accounting/HistoryRecord.md b/docs/accounting/HistoryRecord.md
@@ -17,7 +17,7 @@ require 'XeroRuby::Accounting'
 instance = XeroRuby::Accounting::HistoryRecord.new(details: null,
                                  changes: null,
                                  user: null,
-                                 date_utc: null)
+                                 date_utc: /Date(1573755038314)/)
 ```
 
 
diff --git a/docs/accounting/Invoice.md b/docs/accounting/Invoice.md
@@ -15,26 +15,26 @@ Name | Type | Description | Notes
 **branding_theme_id** | **String** | See BrandingThemes | [optional] 
 **url** | **String** | URL link to a source document – shown as “Go to [appName]” in the Xero app | [optional] 
 **currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**currency_rate** | **Float** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length &#x3D; [18].[6]) | [optional] 
+**currency_rate** | **BigDecimal** | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length &#x3D; [18].[6]) | [optional] 
 **status** | **String** | See Invoice Status Codes | [optional] 
 **sent_to_contact** | **Boolean** | Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved | [optional] 
 **expected_payment_date** | **Date** | Shown on sales invoices (Accounts Receivable) when this has been set | [optional] 
 **planned_payment_date** | **Date** | Shown on bills (Accounts Payable) when this has been set | [optional] 
-**cis_deduction** | **Float** | CIS deduction for UK contractors | [optional] 
-**sub_total** | **Float** | Total of invoice excluding taxes | [optional] 
-**total_tax** | **Float** | Total tax on invoice | [optional] 
-**total** | **Float** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional] 
-**total_discount** | **Float** | Total of discounts applied on the invoice line items | [optional] 
+**cis_deduction** | **BigDecimal** | CIS deduction for UK contractors | [optional] 
+**sub_total** | **BigDecimal** | Total of invoice excluding taxes | [optional] 
+**total_tax** | **BigDecimal** | Total tax on invoice | [optional] 
+**total** | **BigDecimal** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts | [optional] 
+**total_discount** | **BigDecimal** | Total of discounts applied on the invoice line items | [optional] 
 **invoice_id** | **String** | Xero generated unique identifier for invoice | [optional] 
 **has_attachments** | **Boolean** | boolean to indicate if an invoice has an attachment | [optional] [default to false]
 **is_discounted** | **Boolean** | boolean to indicate if an invoice has a discount | [optional] 
 **payments** | [**Array&lt;Payment&gt;**](Payment.md) | See Payments | [optional] 
 **prepayments** | [**Array&lt;Prepayment&gt;**](Prepayment.md) | See Prepayments | [optional] 
 **overpayments** | [**Array&lt;Overpayment&gt;**](Overpayment.md) | See Overpayments | [optional] 
-**amount_due** | **Float** | Amount remaining to be paid on invoice | [optional] 
-**amount_paid** | **Float** | Sum of payments received for invoice | [optional] 
+**amount_due** | **BigDecimal** | Amount remaining to be paid on invoice | [optional] 
+**amount_paid** | **BigDecimal** | Sum of payments received for invoice | [optional] 
 **fully_paid_on_date** | **Date** | The date the invoice was fully paid. Only returned on fully paid invoices | [optional] 
-**amount_credited** | **Float** | Sum of all credit notes, over-payments and pre-payments applied to invoice | [optional] 
+**amount_credited** | **BigDecimal** | Sum of all credit notes, over-payments and pre-payments applied to invoice | [optional] 
 **updated_date_utc** | **DateTime** | Last modified date UTC format | [optional] 
 **credit_notes** | [**Array&lt;CreditNote&gt;**](CreditNote.md) | Details of credit notes that have been applied to an invoice | [optional] 
 **attachments** | [**Array&lt;Attachment&gt;**](Attachment.md) | Displays array of attachments from the API | [optional] 
@@ -79,7 +79,7 @@ instance = XeroRuby::Accounting::Invoice.new(type: null,
                                  amount_paid: null,
                                  fully_paid_on_date: null,
                                  amount_credited: null,
-                                 updated_date_utc: null,
+                                 updated_date_utc: /Date(1573755038314)/,
                                  credit_notes: null,
                                  attachments: null,
                                  has_errors: false,