diff --git a/docs/accounting/index.html b/docs/accounting/index.html index 06d3118a..ad51f113 100644 --- a/docs/accounting/index.html +++ b/docs/accounting/index.html @@ -1669,6 +1669,43 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/BatchPayments/" } +}; + defs["BatchPaymentDelete"] = { + "title" : "", + "required" : [ "BatchPaymentID", "Status" ], + "type" : "object", + "properties" : { + "BatchPaymentID" : { + "type" : "string", + "description" : "The Xero generated unique identifier for the bank transaction (read-only)", + "format" : "uuid" + }, + "Status" : { + "type" : "string", + "description" : "The status of the batch payment.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/accounting/batchpayments" + } +}; + defs["BatchPaymentDeleteByUrlParam"] = { + "title" : "", + "required" : [ "Status" ], + "type" : "object", + "properties" : { + "Status" : { + "type" : "string", + "description" : "The status of the batch payment.", + "default" : "DELETED" + } + }, + "description" : "", + "externalDocs" : { + "url" : "http://developer.xero.com/documentation/api/accounting/batchpayments" + } }; defs["BatchPaymentDetails"] = { "title" : "", @@ -5155,7 +5192,7 @@ }, "HasAttachments" : { "type" : "boolean", - "description" : "boolean to indicate if an invoice has an attachment", + "description" : "Boolean to indicate if an invoice has an attachment", "readOnly" : true, "example" : false, "default" : false @@ -5166,6 +5203,30 @@ "items" : { "$ref" : "#/components/schemas/Attachment" } + }, + "ApprovedForSending" : { + "type" : "boolean", + "description" : "Boolean to indicate whether the invoice has been approved for sending", + "example" : false, + "default" : false + }, + "SendCopy" : { + "type" : "boolean", + "description" : "Boolean to indicate whether a copy is sent to sender's email", + "example" : false, + "default" : false + }, + "MarkAsSent" : { + "type" : "boolean", + "description" : "Boolean to indicate whether the invoice in the Xero app displays as \"sent\"", + "example" : false, + "default" : false + }, + "IncludePDF" : { + "type" : "boolean", + "description" : "Boolean to indicate whether to include PDF attachment", + "example" : false, + "default" : false } }, "description" : "", @@ -6166,6 +6227,9 @@
  • createRepeatingInvoiceHistory
  • +
  • + createRepeatingInvoices +
  • createTaxRates
  • @@ -6178,6 +6242,12 @@
  • deleteAccount
  • +
  • + deleteBatchPayment +
  • +
  • + deleteBatchPaymentByUrlParam +
  • deleteContactGroupContact
  • @@ -6661,6 +6731,9 @@
  • updateOrCreateQuotes
  • +
  • + updateOrCreateRepeatingInvoices +
  • updatePurchaseOrder
  • @@ -6679,6 +6752,9 @@
  • updateReceiptAttachmentByFileName
  • +
  • + updateRepeatingInvoice +
  • updateRepeatingInvoiceAttachmentByFileName
  • @@ -15224,11 +15300,11 @@

    Parameters


    -
    -
    +
    +
    -

    createTaxRates

    -

    Creates one or more tax rates

    +

    createRepeatingInvoices

    +

    Creates one or more repeating invoice templates

    @@ -15236,41 +15312,27 @@

    createTaxRates


    -
    /TaxRates
    +
    /RepeatingInvoices

    Usage and SDK Samples

    -
    +
    xero_client.set_token_set(user.token_set)
     
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    -
    -tax_component = { 
    -  name: "State Tax",
    -  rate: 2.25
    -}    
    -taxComponent = []
    -tax_components << tax_component
    -
    -tax_rate = { 
    -  name: "CA State Tax",
    -  taxComponents: taxComponents,
    -
    -taxRates = {  
    -  tax_rates: [tax_rate]
    -} 
    +summarize_errors = true
     
     begin
    -  response = xero_client.accounting_api.create_tax_rates(xero_tenant_id, taxRates)
    +  response = xero_client.accounting_api.create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors)
       return response
     rescue XeroRuby::ApiError => e
    -  puts "Exception when calling create_tax_rates: #{e}"
    +  puts "Exception when calling create_repeating_invoices: #{e}"
     end
     
    @@ -15279,8 +15341,8 @@

    Scopes

    - - + +
    accounting.settingsGrant read-write access to organisation and account settingsaccounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
    @@ -15295,7 +15357,7 @@

    Parameters

    -
    +
    @@ -15322,15 +15384,15 @@

    Parameters

    Description - taxRates * + repeatingInvoices *
    - TaxRates + RepeatingInvoices
    - TaxRates array with TaxRate object in body of request + RepeatingInvoices with an array of repeating invoice objects in body of request
    @@ -15339,27 +15401,54 @@

    Parameters

    +
    Query parameters
    + + + + + + + + + +
    NameDescription
    summarizeErrors + + +
    +
    +
    + + Boolean + + +
    +If false return 200 OK and mix of successfully created objects and any with validation errors +
    +
    +
    +
    +

    -
    -
    +
    +
    -

    createTrackingCategory

    -

    Create tracking categories

    +

    createTaxRates

    +

    Creates one or more tax rates

    @@ -15367,30 +15456,41 @@

    createTrackingCategory


    -
    /TrackingCategories
    +
    /TaxRates

    Usage and SDK Samples

    -
    +
    xero_client.set_token_set(user.token_set)
     
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     
    -trackingCategory = { 
    -  name: "Foobar"
    -}  
    +tax_component = { 
    +  name: "State Tax",
    +  rate: 2.25
    +}    
    +taxComponent = []
    +tax_components << tax_component
    +
    +tax_rate = { 
    +  name: "CA State Tax",
    +  taxComponents: taxComponents,
    +
    +taxRates = {  
    +  tax_rates: [tax_rate]
    +} 
     
     begin
    -  response = xero_client.accounting_api.create_tracking_category(xero_tenant_id, trackingCategory)
    +  response = xero_client.accounting_api.create_tax_rates(xero_tenant_id, taxRates)
       return response
     rescue XeroRuby::ApiError => e
    -  puts "Exception when calling create_tracking_category: #{e}"
    +  puts "Exception when calling create_tax_rates: #{e}"
     end
     
    @@ -15415,7 +15515,7 @@

    Parameters

    -
    +
    @@ -15442,15 +15542,15 @@

    Parameters

    Description - trackingCategory * + taxRates *
    - TrackingCategory + TaxRates
    - TrackingCategory object in body of request + TaxRates array with TaxRate object in body of request
    @@ -15459,13 +15559,13 @@

    Parameters

    + +
    +
    +
    +
    +
    +
    +

    deleteAccount

    +

    Deletes a chart of accounts

    +
    +
    +
    +

    +

    +

    +
    +
    /Accounts/{AccountID}
    +

    +

    Usage and SDK Samples

    +

    + +
    + +
    +
    xero_client.set_token_set(user.token_set)
    +
    +xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    +account_id = '00000000-0000-0000-0000-000000000000'
    +
    +begin
    +  response = xero_client.accounting_api.delete_account(xero_tenant_id, account_id)
    +  return response
    +rescue XeroRuby::ApiError => e
    +  puts "Exception when calling delete_account: #{e}"
    +end
    +
    +
    +
    +

    Scopes

    + + + + + + + +
    accounting.settingsGrant read-write access to organisation and account settings
    +

    Parameters

    +
    Path parameters
    + + + + + + + + + +
    NameDescription
    AccountID* + + +
    +
    +
    + + UUID + + + (uuid) + + +
    +Unique identifier for Account object
    @@ -15742,6 +15962,276 @@

    Parameters


    +
    +
    +
    +

    deleteBatchPayment

    +

    Updates a specific batch payment for invoices and credit notes

    +
    +
    +
    +

    +

    +

    +
    +
    /BatchPayments
    +

    +

    Usage and SDK Samples

    +

    + +
    + +
    +
    xero_client.set_token_set(user.token_set)
    +
    +xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    +
    +batchPaymentDelete = { 
    +  status: "DELETED"
    +}  
    +  batch_payment_id: "00000000-0000-0000-0000-000000000000"
    +}  
    +
    +begin
    +  response = xero_client.accounting_api.delete_batch_payment(xero_tenant_id, batchPaymentDelete)
    +  return response
    +rescue XeroRuby::ApiError => e
    +  puts "Exception when calling delete_batch_payment: #{e}"
    +end
    +
    +
    +
    +

    Scopes

    + + + + + + + +
    accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
    +

    Parameters

    +
    Header parameters
    + + + + + + + + + +
    NameDescription
    xero-tenant-id* + + +
    +
    +
    + + String + + +
    +Xero identifier for Tenant +
    +
    +
    + Required +
    +
    +
    +
    +
    Body parameters
    + + + + + + + +
    NameDescription
    batchPaymentDelete * +
    +
    + + BatchPaymentDelete + +
    + +
    +
    +
    + Required +
    +
    + +
    +
    +
    +
    +
    +
    +
    +

    deleteBatchPaymentByUrlParam

    +

    Updates a specific batch payment for invoices and credit notes

    +
    +
    +
    +

    +

    +

    +
    +
    /BatchPayments/{BatchPaymentID}
    +

    +

    Usage and SDK Samples

    +

    + +
    + +
    +
    xero_client.set_token_set(user.token_set)
    +
    +xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    +batch_payment_id = '00000000-0000-0000-0000-000000000000'
    +
    +begin
    +  response = xero_client.accounting_api.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batchPaymentDeleteByUrlParam)
    +  return response
    +rescue XeroRuby::ApiError => e
    +  puts "Exception when calling delete_batch_payment_by_url_param: #{e}"
    +end
    +
    +
    +
    +

    Scopes

    + + + + + + + +
    accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
    +

    Parameters

    +
    Path parameters
    + + + + + + + + + +
    NameDescription
    BatchPaymentID* + + +
    +
    +
    + + UUID + + + (uuid) + + +
    +Unique identifier for BatchPayment +
    +
    +
    + Required +
    +
    +
    +
    +
    Header parameters
    + + + + + + + + + +
    NameDescription
    xero-tenant-id* + + +
    +
    +
    + + String + + +
    +Xero identifier for Tenant +
    +
    +
    + Required +
    +
    +
    +
    +
    Body parameters
    + + + + + + + +
    NameDescription
    batchPaymentDeleteByUrlParam * +
    +
    + + BatchPaymentDeleteByUrlParam + +
    + +
    +
    +
    + Required +
    +
    + +
    +
    +
    +
    @@ -39627,6 +40117,150 @@

    Parameters

    +
    +
    +
    +
    +
    +
    +

    updateOrCreateRepeatingInvoices

    +

    Creates or deletes one or more repeating invoice templates

    +
    +
    +
    +

    +

    +

    +
    +
    /RepeatingInvoices
    +

    +

    Usage and SDK Samples

    +

    + +
    + +
    +
    xero_client.set_token_set(user.token_set)
    +
    +xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    +summarize_errors = true
    +
    +begin
    +  response = xero_client.accounting_api.update_or_create_repeating_invoices(xero_tenant_id, repeatingInvoices, summarize_errors)
    +  return response
    +rescue XeroRuby::ApiError => e
    +  puts "Exception when calling update_or_create_repeating_invoices: #{e}"
    +end
    +
    +
    +
    +

    Scopes

    + + + + + + + +
    accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
    +

    Parameters

    +
    Header parameters
    + + + + + + + + + +
    NameDescription
    xero-tenant-id* + + +
    +
    +
    + + String + + +
    +Xero identifier for Tenant +
    +
    +
    + Required +
    +
    +
    +
    +
    Body parameters
    + + + + + + + +
    NameDescription
    repeatingInvoices * +
    +
    + + RepeatingInvoices + +
    + RepeatingInvoices with an array of repeating invoice objects in body of request +
    +
    +
    + Required +
    +
    + +
    +
    Query parameters
    + + + + + + +
    NameDescription
    summarizeErrors + + +
    +
    +
    + + Boolean + + +
    +If false return 200 OK and mix of successfully created objects and any with validation errors +
    +
    +
    +
    +
    @@ -40662,6 +41296,155 @@

    Parameters

    } }, "required" : true +} + + +
    +
    +
    +
    +
    +
    +

    updateRepeatingInvoice

    +

    Deletes a specific repeating invoice template

    +
    +
    +
    +

    +

    +

    +
    +
    /RepeatingInvoices/{RepeatingInvoiceID}
    +

    +

    Usage and SDK Samples

    +

    + +
    + +
    +
    xero_client.set_token_set(user.token_set)
    +
    +xero_tenant_id = 'YOUR_XERO_TENANT_ID'
    +repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
    +
    +begin
    +  response = xero_client.accounting_api.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeatingInvoices)
    +  return response
    +rescue XeroRuby::ApiError => e
    +  puts "Exception when calling update_repeating_invoice: #{e}"
    +end
    +
    +
    +
    +

    Scopes

    + + + + + + + +
    accounting.transactionsGrant read-write access to bank transactions, credit notes, invoices, repeating invoices
    +

    Parameters

    +
    Path parameters
    + + + + + + + + + +
    NameDescription
    RepeatingInvoiceID* + + +
    +
    +
    + + UUID + + + (uuid) + + +
    +Unique identifier for a Repeating Invoice +
    +
    +
    + Required +
    +
    +
    +
    +
    Header parameters
    + + + + + + + + + +
    NameDescription
    xero-tenant-id* + + +
    +
    +
    + + String + + +
    +Xero identifier for Tenant +
    +
    +
    + Required +
    +
    +
    +
    +
    Body parameters
    + + + + + + + +
    NameDescription
    repeatingInvoices * +
    +
    + + RepeatingInvoices + +
    + +
    +
    +
    + Required +
    +
    +
    diff --git a/docs/payroll_au/TaxDeclaration.md b/docs/payroll_au/TaxDeclaration.md index c6ea632c..68dd211c 100644 --- a/docs/payroll_au/TaxDeclaration.md +++ b/docs/payroll_au/TaxDeclaration.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **eligible_to_receive_leave_loading** | **Boolean** | If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false | [optional] **approved_withholding_variation_percentage** | **Float** | If the employee has approved withholding variation. e.g (0 - 100) | [optional] **has_student_startup_loan** | **Boolean** | If the employee is eligible for student startup loan rules | [optional] +**has_loan_or_student_debt** | **Boolean** | If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL) | [optional] **updated_date_utc** | **DateTime** | Last modified timestamp | [optional] ## Code Sample @@ -41,6 +42,7 @@ instance = XeroRuby::PayrollAu::TaxDeclaration.new(employee_id: null, eligible_to_receive_leave_loading: false, approved_withholding_variation_percentage: 75, has_student_startup_loan: true, + has_loan_or_student_debt: true, updated_date_utc: /Date(1583967733054+0000)/) ``` diff --git a/docs/payroll_au/index.html b/docs/payroll_au/index.html index b319937c..4e2fff1c 100644 --- a/docs/payroll_au/index.html +++ b/docs/payroll_au/index.html @@ -1245,7 +1245,7 @@ "title" : "", "type" : "string", "description" : "", - "enum" : [ "FIXED", "ORDINARYTIMEEARNINGS", "OVERTIMEEARNINGS", "ALLOWANCE", "LUMPSUMD", "EMPLOYMENTTERMINATIONPAYMENT", "LUMPSUMA", "LUMPSUMB", "BONUSESANDCOMMISSIONS", "LUMPSUME", "LUMPSUMW", "DIRECTORSFEES" ] + "enum" : [ "FIXED", "ORDINARYTIMEEARNINGS", "OVERTIMEEARNINGS", "ALLOWANCE", "LUMPSUMD", "EMPLOYMENTTERMINATIONPAYMENT", "LUMPSUMA", "LUMPSUMB", "BONUSESANDCOMMISSIONS", "LUMPSUME", "LUMPSUMW", "DIRECTORSFEES", "PAIDPARENTALLEAVE", "WORKERSCOMPENSATION" ] }; defs["Employee"] = { "title" : "", @@ -2985,6 +2985,11 @@ "description" : "If the employee is eligible for student startup loan rules", "example" : true }, + "HasLoanOrStudentDebt" : { + "type" : "boolean", + "description" : "If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)", + "example" : true + }, "UpdatedDateUTC" : { "type" : "string", "description" : "Last modified timestamp", diff --git a/lib/xero-ruby/models/payroll_au/earnings_type.rb b/lib/xero-ruby/models/payroll_au/earnings_type.rb index 08fed927..eaf3b4d0 100644 --- a/lib/xero-ruby/models/payroll_au/earnings_type.rb +++ b/lib/xero-ruby/models/payroll_au/earnings_type.rb @@ -26,6 +26,8 @@ class EarningsType LUMPSUME ||= "LUMPSUME".freeze LUMPSUMW ||= "LUMPSUMW".freeze DIRECTORSFEES ||= "DIRECTORSFEES".freeze + PAIDPARENTALLEAVE ||= "PAIDPARENTALLEAVE".freeze + WORKERSCOMPENSATION ||= "WORKERSCOMPENSATION".freeze # Builds the enum from string # @param [String] The enum value in the form of the string diff --git a/lib/xero-ruby/models/payroll_au/tax_declaration.rb b/lib/xero-ruby/models/payroll_au/tax_declaration.rb index c156f9dd..b40aa4c5 100644 --- a/lib/xero-ruby/models/payroll_au/tax_declaration.rb +++ b/lib/xero-ruby/models/payroll_au/tax_declaration.rb @@ -61,6 +61,9 @@ class TaxDeclaration # If the employee is eligible for student startup loan rules attr_accessor :has_student_startup_loan + # If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL) + attr_accessor :has_loan_or_student_debt + # Last modified timestamp attr_accessor :updated_date_utc @@ -82,6 +85,7 @@ def self.attribute_map :'eligible_to_receive_leave_loading' => :'EligibleToReceiveLeaveLoading', :'approved_withholding_variation_percentage' => :'ApprovedWithholdingVariationPercentage', :'has_student_startup_loan' => :'HasStudentStartupLoan', + :'has_loan_or_student_debt' => :'HasLoanOrStudentDebt', :'updated_date_utc' => :'UpdatedDateUTC' } end @@ -104,6 +108,7 @@ def self.openapi_types :'eligible_to_receive_leave_loading' => :'Boolean', :'approved_withholding_variation_percentage' => :'Float', :'has_student_startup_loan' => :'Boolean', + :'has_loan_or_student_debt' => :'Boolean', :'updated_date_utc' => :'DateTime' } end @@ -183,6 +188,10 @@ def initialize(attributes = {}) self.has_student_startup_loan = attributes[:'has_student_startup_loan'] end + if attributes.key?(:'has_loan_or_student_debt') + self.has_loan_or_student_debt = attributes[:'has_loan_or_student_debt'] + end + if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end @@ -221,6 +230,7 @@ def ==(o) eligible_to_receive_leave_loading == o.eligible_to_receive_leave_loading && approved_withholding_variation_percentage == o.approved_withholding_variation_percentage && has_student_startup_loan == o.has_student_startup_loan && + has_loan_or_student_debt == o.has_loan_or_student_debt && updated_date_utc == o.updated_date_utc end @@ -233,7 +243,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [employee_id, employment_basis, tfn_exemption_type, tax_file_number, australian_resident_for_tax_purposes, residency_status, tax_free_threshold_claimed, tax_offset_estimated_amount, has_help_debt, has_sfss_debt, has_trade_support_loan_debt, upward_variation_tax_withholding_amount, eligible_to_receive_leave_loading, approved_withholding_variation_percentage, has_student_startup_loan, updated_date_utc].hash + [employee_id, employment_basis, tfn_exemption_type, tax_file_number, australian_resident_for_tax_purposes, residency_status, tax_free_threshold_claimed, tax_offset_estimated_amount, has_help_debt, has_sfss_debt, has_trade_support_loan_debt, upward_variation_tax_withholding_amount, eligible_to_receive_leave_loading, approved_withholding_variation_percentage, has_student_startup_loan, has_loan_or_student_debt, updated_date_utc].hash end # Builds the object from hash