xero-ruby 18.3.0 → 18.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70783ce741e09bfe41ae76383a9ae6517ebfd6c2da09eeabe68986105fead384
-  data.tar.gz: 237368497d96525af9b8cf5ff14e1c12b605974c347026f5579b671bd8ad1c8a
+  metadata.gz: 4d75be539ff0ad2fa0d3409f229972e17ae8fe55eb5991bef55106729e151f6a
+  data.tar.gz: 1a763242cf5d8037a7873fd0900d1ed16efa6f65e55820130efeed59e4d0803f
 SHA512:
-  metadata.gz: 28c78c3b5b36272c7a88bc1c3eb9572d19c3e8ecb63f24b2b7874514196bfebe3db255bcd45b529a8bc0945e810dfa6bae336951e41150d5581391cc96473c14
-  data.tar.gz: 797845bb60d9ccc6a8b055407a20fa7707fa1235ba0fb5bc27cd7ca76abfccfdc4cd8014e994bf4bdb0e37cd78b6e31f6b64f52a78110ea191682a30b61bf6e9
+  metadata.gz: dc1addb974222e59ed8149e07587a8ca18c255f47366e4f40b6ed9247a23237815e7214a1191ab24750e30928e130d60876f88024cc8b9d35e4cd45247af07b8
+  data.tar.gz: 24a04f06fcd6349102160b3ee21d3092f3b89404d006b5a38d3b953f45751316c5886e0d47c156d8aedd29a816362bd9a76d3283a260f40517dce5dc4d7a361c

data/lib/xero-ruby/api/account_data_api.rb

@@ -0,0 +1,419 @@
+=begin
+#Xero Account Data API (Beta)
+
+#**Beta:** this API is in beta. Endpoints, request parameters and response shapes may change before general availability.  The Account Data API provides read access to general ledger account data for a Xero organisation: account balances as at a date, account movements over a date range, and the individual account transactions behind them. 
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+module XeroRuby
+  class AccountDataApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.new)
+      @api_client = api_client
+    end
+    # Get the balance of each general ledger account as at a given date
+    # Retrieves account balances as at `date`, optionally including balances for one or more prior comparison periods, and optionally filtered by account class, type, account IDs, system account code, or tracking item.  ### Filtering  - Filter by `class`, `type`, `accountIds`, and/or `systemAccountCodes`. These can be   combined freely — when more than one is supplied, the server returns only accounts   that match **all** of the supplied filters (an intersection, not a union). - `type` values are matched case-sensitively, so use uppercase (for example `BANK`). Inventory   asset accounts are reported as, and can only be filtered by, `INVENTORY`; filtering by   their underlying account type does not match them. - `trackingItemIds` and `unassignedToTrackingCategoryIds` can be used independently of   the filters above to further narrow which accounts are returned.  ### Comparison periods  - Supplying `comparisonPeriodCount` together with `comparisonPeriodSize` returns   additional balances at prior points in time, in addition to the balance at `date`. - The n-th comparison date is `date` shifted back n times `comparisonPeriodSize`. For `MONTH`,   `QUARTER`, and `YEAR` sizes, a `date` that falls on the last day of its month keeps landing   on the last day of the shifted month (so comparisons across February behave correctly). - `comparisonPeriodCount` and `comparisonPeriodSize` must be supplied together.  ### Bank accounts  Bank account data is only available to users with bank account view permission for the organisation.  - If the request would include bank accounts and the user lacks this permission, it is   rejected with `403 Forbidden`. A request is treated as including bank accounts when it   has no account filters, filters by all five `class` values and nothing else, includes   `BANK` in `type`, or lists a bank account in `accountIds`. - For other requests (for example `class=ASSET`), bank accounts are silently excluded from   the response for users without this permission, instead of the request being rejected.  ### Results  Only accounts with a non-zero balance at a given date are returned; accounts and comparison dates with a net-zero balance are omitted, so the response can be empty.  ### Pagination  This endpoint does not paginate — all matching account balances are returned in a single response. 
+    # @param accounting_basis [String] Accounting basis for the balance calculation.
+    # @param date [Date] The date to calculate account balances as at, in ISO 8601 format (YYYY-MM-DD). 
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :comparison_period_count Number of additional comparison balances to return, each one further back in time than the last. Must be supplied together with `comparisonPeriodSize`.  - **Minimum**: 1 - **Maximum**: 100 
+    # @option opts [String] :comparison_period_size The unit of time each comparison period steps back by. Must be supplied together with `comparisonPeriodCount`. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts.  - **Maximum**: 50 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters.
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Can be combined with other filters. 
+    # @option opts [Array<String>] :tracking_item_ids Filter to accounts assigned to any of the given tracking item IDs.
+    # @option opts [Array<String>] :unassigned_to_tracking_category_ids Filter to accounts that are not assigned to any tracking option within the given tracking category IDs. 
+    # @return [AccountBalancesResponse]
+    def get_account_balances(accounting_basis, date, xero_tenant_id, opts = {})
+      data, _status_code, _headers = get_account_balances_with_http_info(accounting_basis, date, xero_tenant_id, opts)
+      data
+    end
+
+    # Get the balance of each general ledger account as at a given date
+    # Retrieves account balances as at &#x60;date&#x60;, optionally including balances for one or more prior comparison periods, and optionally filtered by account class, type, account IDs, system account code, or tracking item.  ### Filtering  - Filter by &#x60;class&#x60;, &#x60;type&#x60;, &#x60;accountIds&#x60;, and/or &#x60;systemAccountCodes&#x60;. These can be   combined freely — when more than one is supplied, the server returns only accounts   that match **all** of the supplied filters (an intersection, not a union). - &#x60;type&#x60; values are matched case-sensitively, so use uppercase (for example &#x60;BANK&#x60;). Inventory   asset accounts are reported as, and can only be filtered by, &#x60;INVENTORY&#x60;; filtering by   their underlying account type does not match them. - &#x60;trackingItemIds&#x60; and &#x60;unassignedToTrackingCategoryIds&#x60; can be used independently of   the filters above to further narrow which accounts are returned.  ### Comparison periods  - Supplying &#x60;comparisonPeriodCount&#x60; together with &#x60;comparisonPeriodSize&#x60; returns   additional balances at prior points in time, in addition to the balance at &#x60;date&#x60;. - The n-th comparison date is &#x60;date&#x60; shifted back n times &#x60;comparisonPeriodSize&#x60;. For &#x60;MONTH&#x60;,   &#x60;QUARTER&#x60;, and &#x60;YEAR&#x60; sizes, a &#x60;date&#x60; that falls on the last day of its month keeps landing   on the last day of the shifted month (so comparisons across February behave correctly). - &#x60;comparisonPeriodCount&#x60; and &#x60;comparisonPeriodSize&#x60; must be supplied together.  ### Bank accounts  Bank account data is only available to users with bank account view permission for the organisation.  - If the request would include bank accounts and the user lacks this permission, it is   rejected with &#x60;403 Forbidden&#x60;. A request is treated as including bank accounts when it   has no account filters, filters by all five &#x60;class&#x60; values and nothing else, includes   &#x60;BANK&#x60; in &#x60;type&#x60;, or lists a bank account in &#x60;accountIds&#x60;. - For other requests (for example &#x60;class&#x3D;ASSET&#x60;), bank accounts are silently excluded from   the response for users without this permission, instead of the request being rejected.  ### Results  Only accounts with a non-zero balance at a given date are returned; accounts and comparison dates with a net-zero balance are omitted, so the response can be empty.  ### Pagination  This endpoint does not paginate — all matching account balances are returned in a single response. 
+    # @param accounting_basis [String] Accounting basis for the balance calculation.
+    # @param date [Date] The date to calculate account balances as at, in ISO 8601 format (YYYY-MM-DD). 
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :comparison_period_count Number of additional comparison balances to return, each one further back in time than the last. Must be supplied together with &#x60;comparisonPeriodSize&#x60;.  - **Minimum**: 1 - **Maximum**: 100 
+    # @option opts [String] :comparison_period_size The unit of time each comparison period steps back by. Must be supplied together with &#x60;comparisonPeriodCount&#x60;. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts.  - **Maximum**: 50 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters.
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Can be combined with other filters. 
+    # @option opts [Array<String>] :tracking_item_ids Filter to accounts assigned to any of the given tracking item IDs.
+    # @option opts [Array<String>] :unassigned_to_tracking_category_ids Filter to accounts that are not assigned to any tracking option within the given tracking category IDs. 
+    # @return [Array<(AccountBalancesResponse, Integer, Hash)>] AccountBalancesResponse data, response status code and response headers
+    def get_account_balances_with_http_info(accounting_basis, date, xero_tenant_id, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDataApi.get_account_balances ...'
+      end
+      # verify the required parameter 'accounting_basis' is set
+      if @api_client.config.client_side_validation && accounting_basis.nil?
+        fail ArgumentError, "Missing the required parameter 'accounting_basis' when calling AccountDataApi.get_account_balances"
+      end
+      # verify enum value
+      allowable_values = ["ACCRUAL", "CASH"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(accounting_basis)
+        fail ArgumentError, "invalid value for \"accounting_basis\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling AccountDataApi.get_account_balances"
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountDataApi.get_account_balances"
+      end
+      if @api_client.config.client_side_validation && !opts[:'comparison_period_count'].nil? && opts[:'comparison_period_count'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"comparison_period_count"]" when calling AccountDataApi.get_account_balances, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'comparison_period_count'].nil? && opts[:'comparison_period_count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"comparison_period_count"]" when calling AccountDataApi.get_account_balances, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]
+      if @api_client.config.client_side_validation && opts[:'comparison_period_size'] && !allowable_values.include?(opts[:'comparison_period_size'])
+        fail ArgumentError, "invalid value for \"comparison_period_size\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_ids'].nil? && opts[:'account_ids'].length > 50
+        fail ArgumentError, 'invalid value for "opts[:"account_ids"]" when calling AccountDataApi.get_account_balances, number of items must be less than or equal to 50.'
+      end
+
+      allowable_values = ["ASSET", "LIABILITY", "EQUITY", "REVENUE", "EXPENSE"]
+      if @api_client.config.client_side_validation && opts[:'_class'] && !opts[:'_class'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"_class\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/account-balances'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountingBasis'] = accounting_basis
+      query_params[:'date'] = date
+      query_params[:'comparisonPeriodCount'] = opts[:'comparison_period_count'] if !opts[:'comparison_period_count'].nil?
+      query_params[:'comparisonPeriodSize'] = opts[:'comparison_period_size'] if !opts[:'comparison_period_size'].nil?
+      query_params[:'accountIds'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
+      query_params[:'class'] = @api_client.build_collection_param(opts[:'_class'], :multi) if !opts[:'_class'].nil?
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
+      query_params[:'systemAccountCodes'] = @api_client.build_collection_param(opts[:'system_account_codes'], :multi) if !opts[:'system_account_codes'].nil?
+      query_params[:'trackingItemIds'] = @api_client.build_collection_param(opts[:'tracking_item_ids'], :multi) if !opts[:'tracking_item_ids'].nil?
+      query_params[:'unassignedToTrackingCategoryIds'] = @api_client.build_collection_param(opts[:'unassigned_to_tracking_category_ids'], :multi) if !opts[:'unassigned_to_tracking_category_ids'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      header_params[:'Xero-Tenant-Id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccountBalancesResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountDataApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDataApi#get_account_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the net movement of each general ledger account over a date range
+    # Retrieves account movements between `startDate` and `endDate`, optionally including movements for one or more prior comparison periods of the same length, and optionally filtered by account class, type, account IDs, system account code, or tracking item.  ### Filtering  - Filter by `class`, `type`, `accountIds`, and/or `systemAccountCodes`. These can be   combined freely — when more than one is supplied, the server returns only accounts   that match **all** of the supplied filters (an intersection, not a union). - `type` values are matched case-sensitively, so use uppercase (for example `BANK`). Inventory   asset accounts are reported as, and can only be filtered by, `INVENTORY`; filtering by   their underlying account type does not match them. - `trackingItemIds` and `unassignedToTrackingCategoryIds` can be used independently of   the filters above to further narrow which accounts are returned.  ### Comparison periods  - Supplying `comparisonPeriodCount` together with `comparisonPeriodSize` returns   additional movements for prior date ranges of the same length, in addition to the   movement between `startDate` and `endDate`. - Each comparison range is calculated by moving the primary range back by   `comparisonPeriodSize`, `comparisonPeriodCount` times. For `MONTH`, `QUARTER`, and   `YEAR` sizes, range boundaries that fall on the last day of a month keep landing on   the last day of the shifted month. - `comparisonPeriodCount` and `comparisonPeriodSize` must be supplied together. - The primary range and every comparison range must not overlap each other. A request   whose periods would overlap is rejected with `400 Bad Request`. Ranges that share a single boundary day count as   overlapping, which month-end adjustment can cause when shifting by `MONTH`, `QUARTER`, or   `YEAR`.  ### Bank accounts  Bank account data is only available to users with bank account view permission for the organisation.  - If the request would include bank accounts and the user lacks this permission, it is   rejected with `403 Forbidden`. A request is treated as including bank accounts when it   has no account filters, filters by all five `class` values and nothing else, includes   `BANK` in `type`, or lists a bank account in `accountIds`. - For other requests (for example `class=ASSET`), bank accounts are silently excluded from   the response for users without this permission, instead of the request being rejected.  ### Pagination  This endpoint does not paginate — the full set of matching account movements is returned in a single response.  ### Results  Only combinations of account and date range with non-zero movement are returned; comparison ranges are not zero-filled. The response is a flat list with no guaranteed ordering. 
+    # @param accounting_basis [String] Accounting basis for the movement calculation.
+    # @param start_date [Date] Start date of the movement range, in ISO 8601 format (YYYY-MM-DD).
+    # @param end_date [Date] End date of the movement range, in ISO 8601 format (YYYY-MM-DD).
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :comparison_period_count Number of additional comparison movements to return, each covering a range further back in time than the last. Must be supplied together with &#x60;comparisonPeriodSize&#x60;.  - **Minimum**: 1 - **Maximum**: 100 
+    # @option opts [String] :comparison_period_size The unit of time each comparison range steps back by. Must be supplied together with &#x60;comparisonPeriodCount&#x60;. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts.  - **Maximum**: 50 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters.
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Can be combined with other filters. 
+    # @option opts [Array<String>] :tracking_item_ids Filter to accounts assigned to any of the given tracking item IDs.
+    # @option opts [Array<String>] :unassigned_to_tracking_category_ids Filter to accounts that are not assigned to any tracking option within the given tracking category IDs. 
+    # @return [AccountMovementsResponse]
+    def get_account_movements(accounting_basis, start_date, end_date, xero_tenant_id, opts = {})
+      data, _status_code, _headers = get_account_movements_with_http_info(accounting_basis, start_date, end_date, xero_tenant_id, opts)
+      data
+    end
+
+    # Get the net movement of each general ledger account over a date range
+    # Retrieves account movements between &#x60;startDate&#x60; and &#x60;endDate&#x60;, optionally including movements for one or more prior comparison periods of the same length, and optionally filtered by account class, type, account IDs, system account code, or tracking item.  ### Filtering  - Filter by &#x60;class&#x60;, &#x60;type&#x60;, &#x60;accountIds&#x60;, and/or &#x60;systemAccountCodes&#x60;. These can be   combined freely — when more than one is supplied, the server returns only accounts   that match **all** of the supplied filters (an intersection, not a union). - &#x60;type&#x60; values are matched case-sensitively, so use uppercase (for example &#x60;BANK&#x60;). Inventory   asset accounts are reported as, and can only be filtered by, &#x60;INVENTORY&#x60;; filtering by   their underlying account type does not match them. - &#x60;trackingItemIds&#x60; and &#x60;unassignedToTrackingCategoryIds&#x60; can be used independently of   the filters above to further narrow which accounts are returned.  ### Comparison periods  - Supplying &#x60;comparisonPeriodCount&#x60; together with &#x60;comparisonPeriodSize&#x60; returns   additional movements for prior date ranges of the same length, in addition to the   movement between &#x60;startDate&#x60; and &#x60;endDate&#x60;. - Each comparison range is calculated by moving the primary range back by   &#x60;comparisonPeriodSize&#x60;, &#x60;comparisonPeriodCount&#x60; times. For &#x60;MONTH&#x60;, &#x60;QUARTER&#x60;, and   &#x60;YEAR&#x60; sizes, range boundaries that fall on the last day of a month keep landing on   the last day of the shifted month. - &#x60;comparisonPeriodCount&#x60; and &#x60;comparisonPeriodSize&#x60; must be supplied together. - The primary range and every comparison range must not overlap each other. A request   whose periods would overlap is rejected with &#x60;400 Bad Request&#x60;. Ranges that share a single boundary day count as   overlapping, which month-end adjustment can cause when shifting by &#x60;MONTH&#x60;, &#x60;QUARTER&#x60;, or   &#x60;YEAR&#x60;.  ### Bank accounts  Bank account data is only available to users with bank account view permission for the organisation.  - If the request would include bank accounts and the user lacks this permission, it is   rejected with &#x60;403 Forbidden&#x60;. A request is treated as including bank accounts when it   has no account filters, filters by all five &#x60;class&#x60; values and nothing else, includes   &#x60;BANK&#x60; in &#x60;type&#x60;, or lists a bank account in &#x60;accountIds&#x60;. - For other requests (for example &#x60;class&#x3D;ASSET&#x60;), bank accounts are silently excluded from   the response for users without this permission, instead of the request being rejected.  ### Pagination  This endpoint does not paginate — the full set of matching account movements is returned in a single response.  ### Results  Only combinations of account and date range with non-zero movement are returned; comparison ranges are not zero-filled. The response is a flat list with no guaranteed ordering. 
+    # @param accounting_basis [String] Accounting basis for the movement calculation.
+    # @param start_date [Date] Start date of the movement range, in ISO 8601 format (YYYY-MM-DD).
+    # @param end_date [Date] End date of the movement range, in ISO 8601 format (YYYY-MM-DD).
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :comparison_period_count Number of additional comparison movements to return, each covering a range further back in time than the last. Must be supplied together with &#x60;comparisonPeriodSize&#x60;.  - **Minimum**: 1 - **Maximum**: 100 
+    # @option opts [String] :comparison_period_size The unit of time each comparison range steps back by. Must be supplied together with &#x60;comparisonPeriodCount&#x60;. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts.  - **Maximum**: 50 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters.
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Can be combined with other filters. 
+    # @option opts [Array<String>] :tracking_item_ids Filter to accounts assigned to any of the given tracking item IDs.
+    # @option opts [Array<String>] :unassigned_to_tracking_category_ids Filter to accounts that are not assigned to any tracking option within the given tracking category IDs. 
+    # @return [Array<(AccountMovementsResponse, Integer, Hash)>] AccountMovementsResponse data, response status code and response headers
+    def get_account_movements_with_http_info(accounting_basis, start_date, end_date, xero_tenant_id, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDataApi.get_account_movements ...'
+      end
+      # verify the required parameter 'accounting_basis' is set
+      if @api_client.config.client_side_validation && accounting_basis.nil?
+        fail ArgumentError, "Missing the required parameter 'accounting_basis' when calling AccountDataApi.get_account_movements"
+      end
+      # verify enum value
+      allowable_values = ["ACCRUAL", "CASH"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(accounting_basis)
+        fail ArgumentError, "invalid value for \"accounting_basis\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling AccountDataApi.get_account_movements"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling AccountDataApi.get_account_movements"
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountDataApi.get_account_movements"
+      end
+      if @api_client.config.client_side_validation && !opts[:'comparison_period_count'].nil? && opts[:'comparison_period_count'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"comparison_period_count"]" when calling AccountDataApi.get_account_movements, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'comparison_period_count'].nil? && opts[:'comparison_period_count'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"comparison_period_count"]" when calling AccountDataApi.get_account_movements, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]
+      if @api_client.config.client_side_validation && opts[:'comparison_period_size'] && !allowable_values.include?(opts[:'comparison_period_size'])
+        fail ArgumentError, "invalid value for \"comparison_period_size\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_ids'].nil? && opts[:'account_ids'].length > 50
+        fail ArgumentError, 'invalid value for "opts[:"account_ids"]" when calling AccountDataApi.get_account_movements, number of items must be less than or equal to 50.'
+      end
+
+      allowable_values = ["ASSET", "LIABILITY", "EQUITY", "REVENUE", "EXPENSE"]
+      if @api_client.config.client_side_validation && opts[:'_class'] && !opts[:'_class'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"_class\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/account-movements'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountingBasis'] = accounting_basis
+      query_params[:'startDate'] = start_date
+      query_params[:'endDate'] = end_date
+      query_params[:'comparisonPeriodCount'] = opts[:'comparison_period_count'] if !opts[:'comparison_period_count'].nil?
+      query_params[:'comparisonPeriodSize'] = opts[:'comparison_period_size'] if !opts[:'comparison_period_size'].nil?
+      query_params[:'accountIds'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
+      query_params[:'class'] = @api_client.build_collection_param(opts[:'_class'], :multi) if !opts[:'_class'].nil?
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
+      query_params[:'systemAccountCodes'] = @api_client.build_collection_param(opts[:'system_account_codes'], :multi) if !opts[:'system_account_codes'].nil?
+      query_params[:'trackingItemIds'] = @api_client.build_collection_param(opts[:'tracking_item_ids'], :multi) if !opts[:'tracking_item_ids'].nil?
+      query_params[:'unassignedToTrackingCategoryIds'] = @api_client.build_collection_param(opts[:'unassigned_to_tracking_category_ids'], :multi) if !opts[:'unassigned_to_tracking_category_ids'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      header_params[:'Xero-Tenant-Id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccountMovementsResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountDataApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDataApi#get_account_movements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get general ledger account transactions between two dates, with pagination and filtering
+    # Retrieves transactions posted between `startDate` and `endDate` (inclusive), optionally filtered by account IDs, class, type, or system account code, with cursor-based pagination for large result sets.  **First call:** omit `token`. Supply `accountingBasis`, `startDate`, and `endDate` (all required), plus any optional filters.  **Continuation calls:** supply only `token`, taken from the previous response's `pagination.nextToken`. Do not send any other query parameters — they are ignored if present, since the original request is captured by the token.  ### Pagination  - Results are returned in pages of 200 lines. - Use `pagination.nextToken` from the response as the `token` query parameter to fetch   the next page. Send only the `token` query parameter on continuation requests — all   other query parameters are   ignored on a continuation call, since the original request's parameters are already   captured by the token. - The `token` value is an opaque string. Treat it as an opaque string only — do not   parse, modify, or construct it yourself. Tokens may expire. - When `pagination` is `null`, you've reached the last page. - The API captures a consistent snapshot at the time of the first request (via   `maxJournalNumber`), so transactions added while you are paginating through a   result set won't appear partway through, and won't cause duplicates or gaps.  ### Filtering  - Filter by `accountIds`, `class`, `type`, and/or `systemAccountCodes`. These can be   combined freely — when more than one is supplied, the server returns only   transactions for accounts that match **all** of the supplied filters (an   intersection, not a union). - `type` values are matched case-sensitively, so use uppercase (for example `BANK`). Inventory   asset accounts are reported as, and can only be filtered by, `INVENTORY`; filtering by   their underlying account type does not match them. - Use `systemAccountCodes=NONE` to match accounts that have no system account code. - Filters are only read from the first request in a pagination sequence — see   Pagination above.  ### Bank accounts  Bank account transactions are only available to users with bank account view permission for the organisation.  - If the user lacks this permission and the request includes `BANK` in `type`, or lists a   bank account in `accountIds`, it is rejected with `403 Forbidden`. - For all other requests, including unfiltered requests, bank account transactions are   silently excluded from the results for users without this permission. 
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accounting_basis Accounting basis for the transaction query. Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Date] :start_date Start date in ISO 8601 format (YYYY-MM-DD). Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Date] :end_date End date in ISO 8601 format (YYYY-MM-DD). Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts. Only used on the first call.  - **Maximum**: 20 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Use &#x60;NONE&#x60; to match accounts with no system account code. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :include Additional data to include in the response. Only used on the first call. 
+    # @option opts [Integer] :max_journal_number Maximum journal number to include in results, for point-in-time queries. If omitted, the server captures the current maximum journal number at the time of the first request and reuses it for every subsequent page, so the whole paginated result set is consistent as at the moment you started. Only used on the first call. 
+    # @option opts [String] :token Continuation token from a previous response&#39;s &#x60;pagination.nextToken&#x60;. When present, all other query parameters are ignored. Opaque — do not parse, modify, or construct it. 
+    # @return [AccountTransactionsResponse]
+    def get_account_transactions(xero_tenant_id, opts = {})
+      data, _status_code, _headers = get_account_transactions_with_http_info(xero_tenant_id, opts)
+      data
+    end
+
+    # Get general ledger account transactions between two dates, with pagination and filtering
+    # Retrieves transactions posted between &#x60;startDate&#x60; and &#x60;endDate&#x60; (inclusive), optionally filtered by account IDs, class, type, or system account code, with cursor-based pagination for large result sets.  **First call:** omit &#x60;token&#x60;. Supply &#x60;accountingBasis&#x60;, &#x60;startDate&#x60;, and &#x60;endDate&#x60; (all required), plus any optional filters.  **Continuation calls:** supply only &#x60;token&#x60;, taken from the previous response&#39;s &#x60;pagination.nextToken&#x60;. Do not send any other query parameters — they are ignored if present, since the original request is captured by the token.  ### Pagination  - Results are returned in pages of 200 lines. - Use &#x60;pagination.nextToken&#x60; from the response as the &#x60;token&#x60; query parameter to fetch   the next page. Send only the &#x60;token&#x60; query parameter on continuation requests — all   other query parameters are   ignored on a continuation call, since the original request&#39;s parameters are already   captured by the token. - The &#x60;token&#x60; value is an opaque string. Treat it as an opaque string only — do not   parse, modify, or construct it yourself. Tokens may expire. - When &#x60;pagination&#x60; is &#x60;null&#x60;, you&#39;ve reached the last page. - The API captures a consistent snapshot at the time of the first request (via   &#x60;maxJournalNumber&#x60;), so transactions added while you are paginating through a   result set won&#39;t appear partway through, and won&#39;t cause duplicates or gaps.  ### Filtering  - Filter by &#x60;accountIds&#x60;, &#x60;class&#x60;, &#x60;type&#x60;, and/or &#x60;systemAccountCodes&#x60;. These can be   combined freely — when more than one is supplied, the server returns only   transactions for accounts that match **all** of the supplied filters (an   intersection, not a union). - &#x60;type&#x60; values are matched case-sensitively, so use uppercase (for example &#x60;BANK&#x60;). Inventory   asset accounts are reported as, and can only be filtered by, &#x60;INVENTORY&#x60;; filtering by   their underlying account type does not match them. - Use &#x60;systemAccountCodes&#x3D;NONE&#x60; to match accounts that have no system account code. - Filters are only read from the first request in a pagination sequence — see   Pagination above.  ### Bank accounts  Bank account transactions are only available to users with bank account view permission for the organisation.  - If the user lacks this permission and the request includes &#x60;BANK&#x60; in &#x60;type&#x60;, or lists a   bank account in &#x60;accountIds&#x60;, it is rejected with &#x60;403 Forbidden&#x60;. - For all other requests, including unfiltered requests, bank account transactions are   silently excluded from the results for users without this permission. 
+    # @param xero_tenant_id [String] The ID of the Xero organisation to query.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accounting_basis Accounting basis for the transaction query. Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Date] :start_date Start date in ISO 8601 format (YYYY-MM-DD). Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Date] :end_date End date in ISO 8601 format (YYYY-MM-DD). Required on the first call; not used (and ignored) on continuation calls made with &#x60;token&#x60;. 
+    # @option opts [Array<String>] :account_ids Filter to specific account IDs (GUIDs). Repeat the parameter for multiple accounts. Only used on the first call.  - **Maximum**: 20 account IDs - **Validation**: Returns 404 if any ID does not exist for the organisation 
+    # @option opts [Array<String>] :_class Account classes to filter by. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :type Account types to filter by (e.g. &#x60;BANK&#x60;, &#x60;CURRENT&#x60;, etc). Use &#x60;INVENTORY&#x60; to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :system_account_codes System account codes to filter by (e.g. &#x60;RETAINEDEARNINGS&#x60;, &#x60;UNREALISEDGAINS&#x60;). Use &#x60;NONE&#x60; to match accounts with no system account code. Can be combined with other filters. Only used on the first call. 
+    # @option opts [Array<String>] :include Additional data to include in the response. Only used on the first call. 
+    # @option opts [Integer] :max_journal_number Maximum journal number to include in results, for point-in-time queries. If omitted, the server captures the current maximum journal number at the time of the first request and reuses it for every subsequent page, so the whole paginated result set is consistent as at the moment you started. Only used on the first call. 
+    # @option opts [String] :token Continuation token from a previous response&#39;s &#x60;pagination.nextToken&#x60;. When present, all other query parameters are ignored. Opaque — do not parse, modify, or construct it. 
+    # @return [Array<(AccountTransactionsResponse, Integer, Hash)>] AccountTransactionsResponse data, response status code and response headers
+    def get_account_transactions_with_http_info(xero_tenant_id, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDataApi.get_account_transactions ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountDataApi.get_account_transactions"
+      end
+      allowable_values = ["ACCRUAL", "CASH"]
+      if @api_client.config.client_side_validation && opts[:'accounting_basis'] && !allowable_values.include?(opts[:'accounting_basis'])
+        fail ArgumentError, "invalid value for \"accounting_basis\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_ids'].nil? && opts[:'account_ids'].length > 20
+        fail ArgumentError, 'invalid value for "opts[:"account_ids"]" when calling AccountDataApi.get_account_transactions, number of items must be less than or equal to 20.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'account_ids'].nil? && opts[:'account_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"account_ids"]" when calling AccountDataApi.get_account_transactions, number of items must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["ASSET", "LIABILITY", "EQUITY", "REVENUE", "EXPENSE"]
+      if @api_client.config.client_side_validation && opts[:'_class'] && !opts[:'_class'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"_class\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["trackingCategories"]
+      if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'max_journal_number'].nil? && opts[:'max_journal_number'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"max_journal_number"]" when calling AccountDataApi.get_account_transactions, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/account-transactions'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountingBasis'] = opts[:'accounting_basis'] if !opts[:'accounting_basis'].nil?
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'accountIds'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
+      query_params[:'class'] = @api_client.build_collection_param(opts[:'_class'], :multi) if !opts[:'_class'].nil?
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
+      query_params[:'systemAccountCodes'] = @api_client.build_collection_param(opts[:'system_account_codes'], :multi) if !opts[:'system_account_codes'].nil?
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
+      query_params[:'maxJournalNumber'] = opts[:'max_journal_number'] if !opts[:'max_journal_number'].nil?
+      query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      header_params[:'Xero-Tenant-Id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccountTransactionsResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountDataApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDataApi#get_account_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/xero-ruby/api_client.rb

@@ -115,6 +115,11 @@ module XeroRuby
       XeroRuby::FinanceApi.new(self)
     end
 
+    def account_data_api
+      @config.base_url = @config.account_data_url
+      XeroRuby::AccountDataApi.new(self)
+    end
+
     # Token Helpers
     def token_set
       @config.token_set
@@ -299,11 +304,14 @@ module XeroRuby
         method_base_url = @config.app_store_url
       when "FinanceApi"
         method_base_url = @config.finance_url
+      when "AccountDataApi"
+        method_base_url = @config.account_data_url
       else
         method_base_url = @config.accounting_url
       end
 
       connection = Faraday.new(:url => method_base_url, :ssl => ssl_options) do |conn|
+        conn.options.params_encoder = Faraday::FlatParamsEncoder if api_client == "AccountDataApi"
         conn.request(:authorization, :basic, config.username, config.password)
         if opts[:header_params]["Content-Type"] == "multipart/form-data"
           conn.request :multipart
@@ -525,6 +533,8 @@ module XeroRuby
           XeroRuby::AppStore.const_get(return_type).build_from_hash(data)
         when 'FinanceApi'
           XeroRuby::Finance.const_get(return_type).build_from_hash(data)
+        when 'AccountDataApi'
+          XeroRuby::AccountData.const_get(return_type).build_from_hash(data)
         else
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
         end

data/lib/xero-ruby/configuration.rb

@@ -35,6 +35,7 @@ module XeroRuby
     attr_accessor :payroll_uk_url
     attr_accessor :app_store_url
     attr_accessor :finance_url
+    attr_accessor :account_data_url
 
     # Defines API keys used with API Key authentications.
     #
@@ -153,6 +154,7 @@ module XeroRuby
       @payroll_uk_url = 'https://api.xero.com/payroll.xro/2.0/'
       @app_store_url = 'https://api.xero.com/appstore/2.0/'
       @finance_url = 'https://api.xero.com/finance.xro/1.0/'
+      @account_data_url = 'https://api.xero.com/accountdata.xro/1.0/'
       @access_token = nil
       @id_token = nil
       @api_key = {}