xero-python 15.3.0__tar.gz → 15.4.0__tar.gz

{xero_python-15.3.0 → xero_python-15.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero_python
-Version: 15.3.0
+Version: 15.4.0
 Summary: Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
 Home-page: UNKNOWN
 Author: Xero Developer API

{xero_python-15.3.0 → xero_python-15.4.0}/setup.py

@@ -48,5 +48,5 @@ setup(
     keywords="xero python sdk API oAuth",
     name="xero_python",
     packages=find_packages(include=["xero_python", "xero_python.*"]),
-    version="15.3.0",
+    version="15.4.0",
 )

{xero_python-15.3.0 → xero_python-15.4.0}/xero_python/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Xero Developer API"""
 __email__ = "api@xero.com"
-__version__ = "15.3.0"
+__version__ = "15.4.0"

xero_python-15.4.0/xero_python/accountdata/__init__.py

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+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.   # noqa: E501
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+"""
+
+
+# import apis into sdk package
+from xero_python.accountdata.api.account_data_api import AccountDataApi
+
+
+# import models into sdk package
+from xero_python.accountdata.models.account import Account
+from xero_python.accountdata.models.account_balance import AccountBalance
+from xero_python.accountdata.models.account_balances_response import (
+    AccountBalancesResponse,
+)
+from xero_python.accountdata.models.account_movement import AccountMovement
+from xero_python.accountdata.models.account_movements_response import (
+    AccountMovementsResponse,
+)
+from xero_python.accountdata.models.account_transaction_line import (
+    AccountTransactionLine,
+)
+from xero_python.accountdata.models.account_transactions_response import (
+    AccountTransactionsResponse,
+)
+from xero_python.accountdata.models.account_transactions_response_pagination import (
+    AccountTransactionsResponsePagination,
+)
+from xero_python.accountdata.models.accounting_date_range import AccountingDateRange
+from xero_python.accountdata.models.field_problem import FieldProblem
+from xero_python.accountdata.models.gateway_problem import GatewayProblem
+from xero_python.accountdata.models.ledger_decimal import LedgerDecimal
+from xero_python.accountdata.models.line_source import LineSource
+from xero_python.accountdata.models.line_tax_rate import LineTaxRate
+from xero_python.accountdata.models.problem_details import ProblemDetails
+from xero_python.accountdata.models.tracking_item_details import TrackingItemDetails
+from xero_python.accountdata.models.transaction_account import TransactionAccount
+from xero_python.accountdata.models.validation_problem import ValidationProblem

xero_python-15.4.0/xero_python/accountdata/api/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa
+
+# import apis into api package
+from xero_python.accountdata.api.account_data_api import AccountDataApi

xero_python-15.4.0/xero_python/accountdata/api/account_data_api.py

@@ -0,0 +1,518 @@
+# coding: utf-8
+
+import importlib
+import re  # noqa: F401
+
+from xero_python import exceptions
+from xero_python.api_client import ApiClient, ModelFinder
+
+try:
+    from .exception_handler import translate_status_exception
+except ImportError:
+    translate_status_exception = exceptions.translate_status_exception
+
+"""
+    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.   # noqa: E501
+
+    Contact: api@xero.com
+    Generated by: https://openapi-generator.tech
+"""
+
+"""
+    OpenAPI spec version: 20.0.1
+"""
+
+
+class empty:
+    """empty object to mark optional parameter not set"""
+
+
+class AccountDataApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    base_url = "https://api.xero.com/accountdata.xro/1.0"
+    models_module = importlib.import_module("xero_python.accountdata.models")
+
+    def __init__(self, api_client=None, base_url=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.base_url = base_url or self.base_url
+
+    def get_resource_url(self, resource_path):
+        """
+        Combine API base url with resource specific path
+        :param str resource_path: API endpoint specific path
+        :return: str full resource path
+        """
+        return self.base_url + resource_path
+
+    def get_model_finder(self):
+        return ModelFinder(self.models_module)
+
+    def get_account_balances(
+        self,
+        accounting_basis,
+        date,
+        xero_tenant_id,
+        comparison_period_count=empty,
+        comparison_period_size=empty,
+        account_ids=empty,
+        _class=empty,
+        type=empty,
+        system_account_codes=empty,
+        tracking_item_ids=empty,
+        unassigned_to_tracking_category_ids=empty,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Get the balance of each general ledger account as at a given date  # noqa: E501
+        OAuth2 scope: accountdata.balances.read
+        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.   # noqa: E501
+        :param str accounting_basis: Accounting basis for the balance calculation. (required)
+        :param date date: The date to calculate account balances as at, in ISO 8601 format (YYYY-MM-DD).  (required)
+        :param str xero_tenant_id: The ID of the Xero organisation to query. (required)
+        :param int 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
+        :param str comparison_period_size: The unit of time each comparison period steps back by. Must be supplied together with `comparisonPeriodCount`.
+        :param list[str] 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
+        :param list[str] _class: Account classes to filter by. Can be combined with other filters.
+        :param list[str] type: Account types to filter by (e.g. `BANK`, `CURRENT`, etc). Use `INVENTORY` to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters.
+        :param list[str] system_account_codes: System account codes to filter by (e.g. `RETAINEDEARNINGS`, `UNREALISEDGAINS`). Can be combined with other filters.
+        :param list[str] tracking_item_ids: Filter to accounts assigned to any of the given tracking item IDs.
+        :param list[str] unassigned_to_tracking_category_ids: Filter to accounts that are not assigned to any tracking option within the given tracking category IDs.
+        :param bool _return_http_data_only: return received data only
+        :param bool _preload_content: load received data in models
+        :param bool _request_timeout: maximum wait time for response
+        :return: AccountBalancesResponse
+        """
+
+        # verify the required parameter 'accounting_basis' is set
+        if accounting_basis is None:
+            raise ValueError(
+                "Missing the required parameter `accounting_basis` "
+                "when calling `get_account_balances`"
+            )
+        # verify the required parameter 'date' is set
+        if date is None:
+            raise ValueError(
+                "Missing the required parameter `date` "
+                "when calling `get_account_balances`"
+            )
+        # verify the required parameter 'xero_tenant_id' is set
+        if xero_tenant_id is None:
+            raise ValueError(
+                "Missing the required parameter `xero_tenant_id` "
+                "when calling `get_account_balances`"
+            )
+
+        if comparison_period_count is not empty and comparison_period_count > 100:
+            raise ValueError(
+                "Invalid value for parameter `comparison_period_count` "
+                "when calling `get_account_balances`, must be a value "
+                "less than or equal to "
+                "`100`"
+            )
+        if comparison_period_count is not empty and comparison_period_count < 1:
+            raise ValueError(
+                "Invalid value for parameter `comparison_period_count` "
+                "when calling `get_account_balances`, must be a value "
+                "greater than or equal to "
+                "`1`"
+            )
+        if account_ids is not empty and len(account_ids) > 50:
+            raise ValueError(
+                "Invalid value for parameter `account_ids` "
+                "when calling `get_account_balances`, number of items "
+                "must be less than or equal to `50`"
+            )
+        collection_formats = {
+            "accountIds": "multi",
+            "class": "multi",
+            "type": "multi",
+            "systemAccountCodes": "multi",
+            "trackingItemIds": "multi",
+            "unassignedToTrackingCategoryIds": "multi",
+        }
+        path_params = {}
+
+        query_params = [
+            ("accountingBasis", accounting_basis),
+            ("date", date),
+        ]
+
+        if comparison_period_count is not empty:
+            query_params.append(("comparisonPeriodCount", comparison_period_count))
+
+        if comparison_period_size is not empty:
+            query_params.append(("comparisonPeriodSize", comparison_period_size))
+
+        if account_ids is not empty:
+            query_params.append(("accountIds", account_ids))
+
+        if _class is not empty:
+            query_params.append(("class", _class))
+
+        if type is not empty:
+            query_params.append(("type", type))
+
+        if system_account_codes is not empty:
+            query_params.append(("systemAccountCodes", system_account_codes))
+
+        if tracking_item_ids is not empty:
+            query_params.append(("trackingItemIds", tracking_item_ids))
+
+        if unassigned_to_tracking_category_ids is not empty:
+            query_params.append(
+                ("unassignedToTrackingCategoryIds", unassigned_to_tracking_category_ids)
+            )
+
+        header_params = {
+            "Xero-Tenant-Id": xero_tenant_id,
+        }
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json", "application/problem+json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/account-balances")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "GET",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="AccountBalancesResponse",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "get_account_balances")
+
+    def get_account_movements(
+        self,
+        accounting_basis,
+        start_date,
+        end_date,
+        xero_tenant_id,
+        comparison_period_count=empty,
+        comparison_period_size=empty,
+        account_ids=empty,
+        _class=empty,
+        type=empty,
+        system_account_codes=empty,
+        tracking_item_ids=empty,
+        unassigned_to_tracking_category_ids=empty,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Get the net movement of each general ledger account over a date range  # noqa: E501
+        OAuth2 scope: accountdata.movements.read
+        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.   # noqa: E501
+        :param str accounting_basis: Accounting basis for the movement calculation. (required)
+        :param date start_date: Start date of the movement range, in ISO 8601 format (YYYY-MM-DD). (required)
+        :param date end_date: End date of the movement range, in ISO 8601 format (YYYY-MM-DD). (required)
+        :param str xero_tenant_id: The ID of the Xero organisation to query. (required)
+        :param int 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 `comparisonPeriodSize`.  - **Minimum**: 1 - **Maximum**: 100
+        :param str comparison_period_size: The unit of time each comparison range steps back by. Must be supplied together with `comparisonPeriodCount`.
+        :param list[str] 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
+        :param list[str] _class: Account classes to filter by. Can be combined with other filters.
+        :param list[str] type: Account types to filter by (e.g. `BANK`, `CURRENT`, etc). Use `INVENTORY` to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters.
+        :param list[str] system_account_codes: System account codes to filter by (e.g. `RETAINEDEARNINGS`, `UNREALISEDGAINS`). Can be combined with other filters.
+        :param list[str] tracking_item_ids: Filter to accounts assigned to any of the given tracking item IDs.
+        :param list[str] unassigned_to_tracking_category_ids: Filter to accounts that are not assigned to any tracking option within the given tracking category IDs.
+        :param bool _return_http_data_only: return received data only
+        :param bool _preload_content: load received data in models
+        :param bool _request_timeout: maximum wait time for response
+        :return: AccountMovementsResponse
+        """
+
+        # verify the required parameter 'accounting_basis' is set
+        if accounting_basis is None:
+            raise ValueError(
+                "Missing the required parameter `accounting_basis` "
+                "when calling `get_account_movements`"
+            )
+        # verify the required parameter 'start_date' is set
+        if start_date is None:
+            raise ValueError(
+                "Missing the required parameter `start_date` "
+                "when calling `get_account_movements`"
+            )
+        # verify the required parameter 'end_date' is set
+        if end_date is None:
+            raise ValueError(
+                "Missing the required parameter `end_date` "
+                "when calling `get_account_movements`"
+            )
+        # verify the required parameter 'xero_tenant_id' is set
+        if xero_tenant_id is None:
+            raise ValueError(
+                "Missing the required parameter `xero_tenant_id` "
+                "when calling `get_account_movements`"
+            )
+
+        if comparison_period_count is not empty and comparison_period_count > 100:
+            raise ValueError(
+                "Invalid value for parameter `comparison_period_count` "
+                "when calling `get_account_movements`, must be a value "
+                "less than or equal to "
+                "`100`"
+            )
+        if comparison_period_count is not empty and comparison_period_count < 1:
+            raise ValueError(
+                "Invalid value for parameter `comparison_period_count` "
+                "when calling `get_account_movements`, must be a value "
+                "greater than or equal to "
+                "`1`"
+            )
+        if account_ids is not empty and len(account_ids) > 50:
+            raise ValueError(
+                "Invalid value for parameter `account_ids` "
+                "when calling `get_account_movements`, number of items "
+                "must be less than or equal to `50`"
+            )
+        collection_formats = {
+            "accountIds": "multi",
+            "class": "multi",
+            "type": "multi",
+            "systemAccountCodes": "multi",
+            "trackingItemIds": "multi",
+            "unassignedToTrackingCategoryIds": "multi",
+        }
+        path_params = {}
+
+        query_params = [
+            ("accountingBasis", accounting_basis),
+            ("startDate", start_date),
+            ("endDate", end_date),
+        ]
+
+        if comparison_period_count is not empty:
+            query_params.append(("comparisonPeriodCount", comparison_period_count))
+
+        if comparison_period_size is not empty:
+            query_params.append(("comparisonPeriodSize", comparison_period_size))
+
+        if account_ids is not empty:
+            query_params.append(("accountIds", account_ids))
+
+        if _class is not empty:
+            query_params.append(("class", _class))
+
+        if type is not empty:
+            query_params.append(("type", type))
+
+        if system_account_codes is not empty:
+            query_params.append(("systemAccountCodes", system_account_codes))
+
+        if tracking_item_ids is not empty:
+            query_params.append(("trackingItemIds", tracking_item_ids))
+
+        if unassigned_to_tracking_category_ids is not empty:
+            query_params.append(
+                ("unassignedToTrackingCategoryIds", unassigned_to_tracking_category_ids)
+            )
+
+        header_params = {
+            "Xero-Tenant-Id": xero_tenant_id,
+        }
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json", "application/problem+json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/account-movements")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "GET",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="AccountMovementsResponse",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "get_account_movements")
+
+    def get_account_transactions(
+        self,
+        xero_tenant_id,
+        accounting_basis=empty,
+        start_date=empty,
+        end_date=empty,
+        account_ids=empty,
+        _class=empty,
+        type=empty,
+        system_account_codes=empty,
+        include=empty,
+        max_journal_number=empty,
+        token=empty,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Get general ledger account transactions between two dates, with pagination and filtering  # noqa: E501
+        OAuth2 scope: accountdata.transactions.read
+        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.   # noqa: E501
+        :param str xero_tenant_id: The ID of the Xero organisation to query. (required)
+        :param str accounting_basis: Accounting basis for the transaction query. Required on the first call; not used (and ignored) on continuation calls made with `token`.
+        :param 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 `token`.
+        :param 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 `token`.
+        :param list[str] 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
+        :param list[str] _class: Account classes to filter by. Can be combined with other filters. Only used on the first call.
+        :param list[str] type: Account types to filter by (e.g. `BANK`, `CURRENT`, etc). Use `INVENTORY` to match inventory asset accounts, regardless of their underlying account type. Can be combined with other filters. Only used on the first call.
+        :param list[str] system_account_codes: System account codes to filter by (e.g. `RETAINEDEARNINGS`, `UNREALISEDGAINS`). Use `NONE` to match accounts with no system account code. Can be combined with other filters. Only used on the first call.
+        :param list[str] include: Additional data to include in the response. Only used on the first call.
+        :param int 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.
+        :param str token: Continuation token from a previous response's `pagination.nextToken`. When present, all other query parameters are ignored. Opaque — do not parse, modify, or construct it.
+        :param bool _return_http_data_only: return received data only
+        :param bool _preload_content: load received data in models
+        :param bool _request_timeout: maximum wait time for response
+        :return: AccountTransactionsResponse
+        """
+
+        # verify the required parameter 'xero_tenant_id' is set
+        if xero_tenant_id is None:
+            raise ValueError(
+                "Missing the required parameter `xero_tenant_id` "
+                "when calling `get_account_transactions`"
+            )
+
+        if account_ids is not empty and len(account_ids) > 20:
+            raise ValueError(
+                "Invalid value for parameter `account_ids` "
+                "when calling `get_account_transactions`, number of items "
+                "must be less than or equal to `20`"
+            )
+        if account_ids is not empty and len(account_ids) < 1:
+            raise ValueError(
+                "Invalid value for parameter `account_ids` "
+                "when calling `get_account_transactions`, number of items "
+                "must be greater than or equal to `1`"
+            )
+        if max_journal_number is not empty and max_journal_number < 0:
+            raise ValueError(
+                "Invalid value for parameter `max_journal_number` "
+                "when calling `get_account_transactions`, must be a value "
+                "greater than or equal to "
+                "`0`"
+            )
+        collection_formats = {
+            "accountIds": "multi",
+            "class": "multi",
+            "type": "multi",
+            "systemAccountCodes": "multi",
+            "include": "multi",
+        }
+        path_params = {}
+
+        query_params = []
+
+        if accounting_basis is not empty:
+            query_params.append(("accountingBasis", accounting_basis))
+
+        if start_date is not empty:
+            query_params.append(("startDate", start_date))
+
+        if end_date is not empty:
+            query_params.append(("endDate", end_date))
+
+        if account_ids is not empty:
+            query_params.append(("accountIds", account_ids))
+
+        if _class is not empty:
+            query_params.append(("class", _class))
+
+        if type is not empty:
+            query_params.append(("type", type))
+
+        if system_account_codes is not empty:
+            query_params.append(("systemAccountCodes", system_account_codes))
+
+        if include is not empty:
+            query_params.append(("include", include))
+
+        if max_journal_number is not empty:
+            query_params.append(("maxJournalNumber", max_journal_number))
+
+        if token is not empty:
+            query_params.append(("token", token))
+
+        header_params = {
+            "Xero-Tenant-Id": xero_tenant_id,
+        }
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json", "application/problem+json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/account-transactions")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "GET",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="AccountTransactionsResponse",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "get_account_transactions")

xero_python-15.4.0/xero_python/accountdata/models/__init__.py

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+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.   # noqa: E501
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+"""
+
+
+# import models into model package
+from xero_python.accountdata.models.account import Account
+from xero_python.accountdata.models.account_balance import AccountBalance
+from xero_python.accountdata.models.account_balances_response import (
+    AccountBalancesResponse,
+)
+from xero_python.accountdata.models.account_movement import AccountMovement
+from xero_python.accountdata.models.account_movements_response import (
+    AccountMovementsResponse,
+)
+from xero_python.accountdata.models.account_transaction_line import (
+    AccountTransactionLine,
+)
+from xero_python.accountdata.models.account_transactions_response import (
+    AccountTransactionsResponse,
+)
+from xero_python.accountdata.models.account_transactions_response_pagination import (
+    AccountTransactionsResponsePagination,
+)
+from xero_python.accountdata.models.accounting_date_range import AccountingDateRange
+from xero_python.accountdata.models.field_problem import FieldProblem
+from xero_python.accountdata.models.gateway_problem import GatewayProblem
+from xero_python.accountdata.models.ledger_decimal import LedgerDecimal
+from xero_python.accountdata.models.line_source import LineSource
+from xero_python.accountdata.models.line_tax_rate import LineTaxRate
+from xero_python.accountdata.models.problem_details import ProblemDetails
+from xero_python.accountdata.models.tracking_item_details import TrackingItemDetails
+from xero_python.accountdata.models.transaction_account import TransactionAccount
+from xero_python.accountdata.models.validation_problem import ValidationProblem