diff --git a/Avalara/SDK/api/EInvoicing/V1/code_lists_api.py b/Avalara/SDK/api/EInvoicing/V1/code_lists_api.py new file mode 100644 index 0000000..84767e5 --- /dev/null +++ b/Avalara/SDK/api/EInvoicing/V1/code_lists_api.py @@ -0,0 +1,395 @@ +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +import re # noqa: F401 +import sys # noqa: F401 +import decimal + +from Avalara.SDK.api_client import ApiClient, Endpoint as _Endpoint +from Avalara.SDK.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from datetime import date +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from Avalara.SDK.models.EInvoicing.V1.code_list_list_response import CodeListListResponse +from Avalara.SDK.models.EInvoicing.V1.code_list_response import CodeListResponse +from Avalara.SDK.exceptions import ApiTypeError, ApiValueError, ApiException +from Avalara.SDK.oauth_helper.AvalaraSdkOauthUtils import avalara_retry_oauth + +class CodeListsApi(object): + + def __init__(self, api_client): + self.__set_configuration(api_client) + + def __verify_api_client(self,api_client): + if api_client is None: + raise ApiValueError("APIClient not defined") + + def __set_configuration(self, api_client): + self.__verify_api_client(api_client) + api_client.set_sdk_version("26.4.0") + self.api_client = api_client + + self.get_code_list_endpoint = _Endpoint( + settings={ + 'response_type': (CodeListResponse,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/einvoicing/codelists/{codelistId}', + 'operation_id': 'get_code_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'avalara_version', + 'codelist_id', + 'country_code', + 'x_avalara_client', + 'effective_date', + 'sunset_date', + ], + 'required': [ + 'avalara_version', + 'codelist_id', + 'country_code', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'avalara_version': + (str,), + 'codelist_id': + (str,), + 'country_code': + (str,), + 'x_avalara_client': + (str,), + 'effective_date': + (date,), + 'sunset_date': + (date,), + }, + 'attribute_map': { + 'avalara_version': 'avalara-version', + 'codelist_id': 'codelistId', + 'country_code': 'countryCode', + 'x_avalara_client': 'X-Avalara-Client', + 'effective_date': 'effectiveDate', + 'sunset_date': 'sunsetDate', + }, + 'location_map': { + 'avalara_version': 'header', + 'codelist_id': 'path', + 'country_code': 'query', + 'x_avalara_client': 'header', + 'effective_date': 'query', + 'sunset_date': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'avalara-version': '1.6', + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + required_scopes='', + microservice='EInvoicing' + ) + self.get_code_list_list_endpoint = _Endpoint( + settings={ + 'response_type': (CodeListListResponse,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/einvoicing/codelists', + 'operation_id': 'get_code_list_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'avalara_version', + 'country_code', + 'x_avalara_client', + 'effective_date', + 'sunset_date', + 'count', + 'count_only', + 'top', + 'skip', + ], + 'required': [ + 'avalara_version', + 'country_code', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'avalara_version': + (str,), + 'country_code': + (str,), + 'x_avalara_client': + (str,), + 'effective_date': + (date,), + 'sunset_date': + (date,), + 'count': + (str,), + 'count_only': + (str,), + 'top': + (int,), + 'skip': + (int,), + }, + 'attribute_map': { + 'avalara_version': 'avalara-version', + 'country_code': 'countryCode', + 'x_avalara_client': 'X-Avalara-Client', + 'effective_date': 'effectiveDate', + 'sunset_date': 'sunsetDate', + 'count': '$count', + 'count_only': '$countOnly', + 'top': '$top', + 'skip': '$skip', + }, + 'location_map': { + 'avalara_version': 'header', + 'country_code': 'query', + 'x_avalara_client': 'header', + 'effective_date': 'query', + 'sunset_date': 'query', + 'count': 'query', + 'count_only': 'query', + 'top': 'query', + 'skip': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'avalara-version': '1.6', + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + required_scopes='', + microservice='EInvoicing' + ) + + @avalara_retry_oauth(max_retry_attempts=2) + def get_code_list( + self, + avalara_version, + codelist_id, + country_code, + **kwargs + ): + """Retrieves a code list by ID for a specific country # noqa: E501 + + A Code List is a controlled set of predefined, standardized values used to populate specific fields in electronic documents (such as e-invoices). Each code has a stable, machine-readable identifier and a human-readable description. Code Lists are typically based on global standards (e.g., UN/CEFACT, ISO, EN16931) and may include jurisdiction-specific extensions or restrictions.

Code Lists are versioned, and each version may have defined effective and sunset dates to ensure that the correct set of allowable values is applied according to regulatory or jurisdictional requirements.

By default, the API returns only non-expired code list versions (versions where the sunset date has not passed). To retrieve expired versions or filter by specific date ranges, use the effectiveDate and sunsetDate query parameters. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_code_list(avalara_version, codelist_id, country_code, async_req=True) + >>> result = thread.get() + + Args: + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + codelist_id (str): System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs. + country_code (str): Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to. + + Keyword Args: + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + effective_date (date): Filter code list versions by effective date. Returns versions that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided.. [optional] + sunset_date (date): Filter code list versions by sunset date. Returns versions that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired versions are returned.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CodeListResponse + If the method is called asynchronously, returns the request + thread. + """ + self.__verify_api_client(self.api_client) + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['avalara_version'] = avalara_version + kwargs['codelist_id'] = codelist_id + kwargs['country_code'] = country_code + return self.get_code_list_endpoint.call_with_http_info(**kwargs) + + @avalara_retry_oauth(max_retry_attempts=2) + def get_code_list_list( + self, + avalara_version, + country_code, + **kwargs + ): + """Returns a list of code lists for a specific country # noqa: E501 + + Get a list of code lists on the Avalara E-Invoicing platform for the specified country. By default, the API returns only non-expired code lists (code lists where the sunset date has not passed). To retrieve expired code lists or filter by specific date ranges, use the effectiveDate and sunsetDate query parameters.

A Code List is a controlled set of predefined, standardized values used to populate specific fields in electronic documents (such as e-invoices). Each code has a stable, machine-readable identifier and a human-readable description. Code Lists are typically based on global standards (e.g., UN/CEFACT, ISO, EN16931) and may include jurisdiction-specific extensions or restrictions. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_code_list_list(avalara_version, country_code, async_req=True) + >>> result = thread.get() + + Args: + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + country_code (str): Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction for which code lists should be returned. + + Keyword Args: + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + effective_date (date): Filter code lists by effective date. Returns code lists that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided.. [optional] + sunset_date (date): Filter code lists by sunset date. Returns code lists that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired code lists are returned.. [optional] + count (str): When set to true, the response body also includes the count of items in the collection.. [optional] + count_only (str): When set to true, the response returns only the count of items in the collection.. [optional] + top (int): The number of items to include in the result.. [optional] + skip (int): The number of items to skip in the result.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CodeListListResponse + If the method is called asynchronously, returns the request + thread. + """ + self.__verify_api_client(self.api_client) + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['avalara_version'] = avalara_version + kwargs['country_code'] = country_code + return self.get_code_list_list_endpoint.call_with_http_info(**kwargs) + diff --git a/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py b/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py index 884f1a8..537e128 100644 --- a/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/data_input_fields_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,7 +58,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.get_data_input_fields_endpoint = _Endpoint( @@ -135,7 +135,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -154,7 +154,7 @@ def get_data_input_fields( ): """Returns the optionality of document fields for different country mandates # noqa: E501 - This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the mandates endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate # noqa: E501 + This endpoint returns a list of required, conditional, and optional fields for each country mandate. Use the mandates endpoint to retrieve all available country mandates. Use the $filter query parameter to retrieve fields for a specific mandate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -162,15 +162,15 @@ def get_data_input_fields( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] - filter (str): Filter by field name and value. This filter only supports eq and contains. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + filter (str): Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide.. [optional] top (int): The number of items to include in the result.. [optional] skip (int): The number of items to skip in the result.. [optional] - count (bool): When set to true, the count of the collection is also returned in the response body. [optional] - count_only (bool): When set to true, only the count of the collection is returned. [optional] + count (bool): When set to true, the response body also includes the count of items in the collection.. [optional] + count_only (bool): When set to true, the response returns only the count of items in the collection.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/EInvoicing/V1/documents_api.py b/Avalara/SDK/api/EInvoicing/V1/documents_api.py index ca5ebfa..10c32e0 100644 --- a/Avalara/SDK/api/EInvoicing/V1/documents_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/documents_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -64,7 +64,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.download_document_endpoint = _Endpoint( @@ -128,7 +128,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/pdf', 'application/xml', @@ -194,7 +194,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -227,6 +227,7 @@ def __set_configuration(self, api_client): 'count', 'count_only', 'filter', + 'include', 'top', 'skip', ], @@ -262,6 +263,8 @@ def __set_configuration(self, api_client): (str,), 'filter': (str,), + 'include': + (str,), 'top': (int,), 'skip': @@ -276,6 +279,7 @@ def __set_configuration(self, api_client): 'count': '$count', 'count_only': '$countOnly', 'filter': '$filter', + 'include': '$include', 'top': '$top', 'skip': '$skip', }, @@ -288,6 +292,7 @@ def __set_configuration(self, api_client): 'count': 'query', 'count_only': 'query', 'filter': 'query', + 'include': 'query', 'top': 'query', 'skip': 'query', }, @@ -295,7 +300,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -360,7 +365,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -431,7 +436,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json', 'text/xml' @@ -455,7 +460,7 @@ def download_document( ): """Returns a copy of the document # noqa: E501 - When the document is available, use this endpoint to download it as text, XML, or PDF. The output format needs to be specified in the Accept header, and it will vary depending on the mandate. If the file has not yet been created, then status code 404 (not found) is returned. # noqa: E501 + Downloads the document when it is available. Specify the output format in the Accept header. Returns 404 if the file has not been created. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -463,12 +468,12 @@ def download_document( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used - accept (str): This header indicates the MIME type of the document - document_id (str): The unique ID for this document that was returned in the POST /einvoicing/document response body + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + accept (str): Header that specifies the MIME type of the returned document. + document_id (str): The unique documentId returned in the POST /documents response body. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -528,7 +533,7 @@ def fetch_documents( ): """Fetch the inbound document from a tax authority # noqa: E501 - This API allows you to retrieve an inbound document. Pass key-value pairs as parameters in the request, such as the confirmation number, supplier number, and buyer VAT number. # noqa: E501 + Retrieves an inbound document. Provide key-value pairs as request parameters. Supported parameters vary by tax authority and country. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -536,11 +541,11 @@ def fetch_documents( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). fetch_documents_request (FetchDocumentsRequest): Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -598,7 +603,7 @@ def get_document_list( ): """Returns a summary of documents for a date range # noqa: E501 - Get a list of documents on the Avalara E-Invoicing platform that have a processing date within the specified date range. # noqa: E501 + Returns a list of document summaries with a processing date within the specified date range. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -606,16 +611,17 @@ def get_document_list( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] - start_date (datetime): Start date of documents to return. This defaults to the previous month.. [optional] - end_date (datetime): End date of documents to return. This defaults to the current date.. [optional] - flow (str): Optionally filter by document direction, where issued = `out` and received = `in`. [optional] - count (str): When set to true, the count of the collection is also returned in the response body. [optional] - count_only (str): When set to true, only the count of the collection is returned. [optional] - filter (str): Filter by field name and value. This filter only supports eq . Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided startDate and endDate. If no startDate or endDate is provided, defaults will be assumed.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + start_date (datetime): Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\".. [optional] + end_date (datetime): End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\".. [optional] + flow (str): Optional filter for document direction: issued uses \"out\" and received uses \"in\".. [optional] + count (str): When set to true, the response body also includes the count of items in the collection.. [optional] + count_only (str): When set to true, the response returns only the count of items in the collection.. [optional] + filter (str): Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide.. [optional] + include (str): When set to `events`, each document in the response includes its events array. Omit this parameter or use any other value to exclude events from the response.. [optional] top (int): The number of items to include in the result.. [optional] skip (int): The number of items to skip in the result.. [optional] _return_http_data_only (bool): response data without head status @@ -675,7 +681,7 @@ def get_document_status( ): """Checks the status of a document # noqa: E501 - Using the unique ID from POST /einvoicing/documents response body, request the current status of a document. # noqa: E501 + Uses the documentId from the POST /documents response body to return the current status of a document. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -683,11 +689,11 @@ def get_document_status( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used - document_id (str): The unique ID for this document that was returned in the POST /einvoicing/documents response body + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + document_id (str): The unique documentId returned in the POST /documents response body. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -755,12 +761,12 @@ def submit_document( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). metadata (SubmitDocumentMetadata): data (object): The document to be submitted, as indicated by the metadata fields 'dataFormat' and 'dataFormatVersion' Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/EInvoicing/V1/interop_api.py b/Avalara/SDK/api/EInvoicing/V1/interop_api.py index d41ede5..203c0dc 100644 --- a/Avalara/SDK/api/EInvoicing/V1/interop_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/interop_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -58,7 +58,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.submit_interop_document_endpoint = _Endpoint( @@ -145,7 +145,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -168,7 +168,7 @@ def submit_interop_document( ): """Submit a document # noqa: E501 - This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers. # noqa: E501 + Upload documents on behalf of interoperability partners and submit them to trading partners through the Avalara platform. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -178,11 +178,11 @@ def submit_interop_document( Args: document_type (str): Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents. interchange_type (str): Type of interchange (codes in Avalara system that uniquely identifies a type of interchange). Partners will be configured in Avalara system to send documents belonging to certain types of interchanges. - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] file_name (bytearray): The file to be uploaded (e.g., UBL XML, CII XML).. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. diff --git a/Avalara/SDK/api/EInvoicing/V1/mandates_api.py b/Avalara/SDK/api/EInvoicing/V1/mandates_api.py index 35cbed5..5a9c525 100644 --- a/Avalara/SDK/api/EInvoicing/V1/mandates_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/mandates_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -59,7 +59,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.get_mandate_data_input_fields_endpoint = _Endpoint( @@ -129,7 +129,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -213,7 +213,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -243,13 +243,13 @@ def get_mandate_data_input_fields( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used - mandate_id (str): The unique ID for the mandate that was returned in the GET /einvoicing/mandates response body + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + mandate_id (str): Unique identifier of the mandate returned by the GET /mandates endpoint. document_type (str): Select the documentType for which you wish to view the data-input-fields (You may obtain the supported documentTypes from the GET /mandates endpoint) document_version (str): Select the document version of the documentType (You may obtain the supported documentVersion from the GET /mandates endpoint) Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -317,15 +317,15 @@ def get_mandates( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] filter (str): Filter by field name and value. This filter only supports eq and contains. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.. [optional] top (int): The number of items to include in the result.. [optional] skip (int): The number of items to skip in the result.. [optional] count (bool): When set to true, the count of the collection is also returned in the response body.. [optional] - count_only (bool): When set to true, only the count of the collection is returned. [optional] + count_only (bool): When set to true, only the count of the collection is returned.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/EInvoicing/V1/reports_api.py b/Avalara/SDK/api/EInvoicing/V1/reports_api.py new file mode 100644 index 0000000..77193ea --- /dev/null +++ b/Avalara/SDK/api/EInvoicing/V1/reports_api.py @@ -0,0 +1,519 @@ +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +import re # noqa: F401 +import sys # noqa: F401 +import decimal + +from Avalara.SDK.api_client import ApiClient, Endpoint as _Endpoint +from Avalara.SDK.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from Avalara.SDK.models.EInvoicing.V1.report_download_response import ReportDownloadResponse +from Avalara.SDK.models.EInvoicing.V1.report_item import ReportItem +from Avalara.SDK.models.EInvoicing.V1.report_list_response import ReportListResponse +from Avalara.SDK.exceptions import ApiTypeError, ApiValueError, ApiException +from Avalara.SDK.oauth_helper.AvalaraSdkOauthUtils import avalara_retry_oauth + +class ReportsApi(object): + + def __init__(self, api_client): + self.__set_configuration(api_client) + + def __verify_api_client(self,api_client): + if api_client is None: + raise ApiValueError("APIClient not defined") + + def __set_configuration(self, api_client): + self.__verify_api_client(api_client) + api_client.set_sdk_version("26.4.0") + self.api_client = api_client + + self.download_report_endpoint = _Endpoint( + settings={ + 'response_type': (ReportDownloadResponse,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/einvoicing/reports/{reportId}/$download', + 'operation_id': 'download_report', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'avalara_version', + 'report_id', + 'x_avalara_client', + 'x_correlation_id', + ], + 'required': [ + 'avalara_version', + 'report_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'avalara_version': + (str,), + 'report_id': + (str,), + 'x_avalara_client': + (str,), + 'x_correlation_id': + (str,), + }, + 'attribute_map': { + 'avalara_version': 'avalara-version', + 'report_id': 'reportId', + 'x_avalara_client': 'X-Avalara-Client', + 'x_correlation_id': 'X-Correlation-ID', + }, + 'location_map': { + 'avalara_version': 'header', + 'report_id': 'path', + 'x_avalara_client': 'header', + 'x_correlation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'avalara-version': '1.6', + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + required_scopes='', + microservice='EInvoicing' + ) + self.get_report_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (ReportItem,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/einvoicing/reports/{reportId}/status', + 'operation_id': 'get_report_by_id', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'avalara_version', + 'report_id', + 'x_avalara_client', + 'x_correlation_id', + ], + 'required': [ + 'avalara_version', + 'report_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'avalara_version': + (str,), + 'report_id': + (str,), + 'x_avalara_client': + (str,), + 'x_correlation_id': + (str,), + }, + 'attribute_map': { + 'avalara_version': 'avalara-version', + 'report_id': 'reportId', + 'x_avalara_client': 'X-Avalara-Client', + 'x_correlation_id': 'X-Correlation-ID', + }, + 'location_map': { + 'avalara_version': 'header', + 'report_id': 'path', + 'x_avalara_client': 'header', + 'x_correlation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'avalara-version': '1.6', + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + required_scopes='', + microservice='EInvoicing' + ) + self.get_reports_endpoint = _Endpoint( + settings={ + 'response_type': (ReportListResponse,), + 'auth': [ + 'Bearer' + ], + 'endpoint_path': '/einvoicing/reports', + 'operation_id': 'get_reports', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'avalara_version', + 'x_avalara_client', + 'x_correlation_id', + 'filter', + 'top', + 'skip', + 'count', + 'count_only', + 'orderby', + ], + 'required': [ + 'avalara_version', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'avalara_version': + (str,), + 'x_avalara_client': + (str,), + 'x_correlation_id': + (str,), + 'filter': + (str,), + 'top': + (int,), + 'skip': + (int,), + 'count': + (str,), + 'count_only': + (str,), + 'orderby': + (str,), + }, + 'attribute_map': { + 'avalara_version': 'avalara-version', + 'x_avalara_client': 'X-Avalara-Client', + 'x_correlation_id': 'X-Correlation-ID', + 'filter': '$filter', + 'top': '$top', + 'skip': '$skip', + 'count': '$count', + 'count_only': '$countOnly', + 'orderby': '$orderby', + }, + 'location_map': { + 'avalara_version': 'header', + 'x_avalara_client': 'header', + 'x_correlation_id': 'header', + 'filter': 'query', + 'top': 'query', + 'skip': 'query', + 'count': 'query', + 'count_only': 'query', + 'orderby': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'avalara-version': '1.6', + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + required_scopes='', + microservice='EInvoicing' + ) + + @avalara_retry_oauth(max_retry_attempts=2) + def download_report( + self, + avalara_version, + report_id, + **kwargs + ): + """Returns a pre-signed download URL for a report # noqa: E501 + + Returns a pre-signed URL to download the report file when it is available. If the report has not yet been generated, a 404 (not found) is returned. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_report(avalara_version, report_id, async_req=True) + >>> result = thread.get() + + Args: + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + report_id (str): The unique ID for this report as returned in a GET /reports response. + + Keyword Args: + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ReportDownloadResponse + If the method is called asynchronously, returns the request + thread. + """ + self.__verify_api_client(self.api_client) + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['avalara_version'] = avalara_version + kwargs['report_id'] = report_id + return self.download_report_endpoint.call_with_http_info(**kwargs) + + @avalara_retry_oauth(max_retry_attempts=2) + def get_report_by_id( + self, + avalara_version, + report_id, + **kwargs + ): + """Retrieves a report by its unique ID # noqa: E501 + + Retrieves a specific report by its unique identifier. Returns complete report details including metadata, status, and associated information. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_report_by_id(avalara_version, report_id, async_req=True) + >>> result = thread.get() + + Args: + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + report_id (str): The unique ID for this report as returned in a GET /reports response. + + Keyword Args: + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ReportItem + If the method is called asynchronously, returns the request + thread. + """ + self.__verify_api_client(self.api_client) + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['avalara_version'] = avalara_version + kwargs['report_id'] = report_id + return self.get_report_by_id_endpoint.call_with_http_info(**kwargs) + + @avalara_retry_oauth(max_retry_attempts=2) + def get_reports( + self, + avalara_version, + **kwargs + ): + """Returns a list of reports # noqa: E501 + + Retrieves all reports with optional filtering, paging, and sorting. Results are filtered by tenant. Supports OData-style filtering using the $filter parameter. Use $top and $skip for paging; when more results exist, the response includes @nextLink to fetch the next page. Default sort order is by report generation date (descending). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_reports(avalara_version, async_req=True) + >>> result = thread.get() + + Args: + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + + Keyword Args: + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] + filter (str): OData-style filter expression. Supports operators: eq, ne, gt, ge, lt, le, like, ilike, contains. Examples: status eq 'COMPLETED', reportGenerateDate gt '2025-11-01', transactionIds contains 'TXN-2025-001'. [optional] + top (int): The number of items to include in the result.. [optional] + skip (int): The number of items to skip in the result.. [optional] + count (str): When set to true, the response body also includes the count of items in the collection.. [optional] + count_only (str): When set to true, the response returns only the count of items in the collection.. [optional] + orderby (str): OData-style orderby expression. Format: 'field asc' or 'field desc'. Default: reportGenerateDate desc. [optional] if omitted the server will use the default value of 'reportGenerateDate desc' + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ReportListResponse + If the method is called asynchronously, returns the request + thread. + """ + self.__verify_api_client(self.api_client) + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['avalara_version'] = avalara_version + return self.get_reports_endpoint.call_with_http_info(**kwargs) + diff --git a/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py b/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py index 9146ab7..998e2bd 100644 --- a/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/subscriptions_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -61,7 +61,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.create_webhook_subscription_endpoint = _Endpoint( @@ -123,7 +123,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -141,7 +141,7 @@ def __set_configuration(self, api_client): 'auth': [ 'Bearer' ], - 'endpoint_path': '/einvoicing/webhooks/subscriptions/{subscription-id}', + 'endpoint_path': '/einvoicing/webhooks/subscriptions/{subscriptionId}', 'operation_id': 'delete_webhook_subscription', 'http_method': 'DELETE', 'servers': None, @@ -180,7 +180,7 @@ def __set_configuration(self, api_client): (str,), }, 'attribute_map': { - 'subscription_id': 'subscription-id', + 'subscription_id': 'subscriptionId', 'avalara_version': 'avalara-version', 'x_correlation_id': 'X-Correlation-ID', 'x_avalara_client': 'X-Avalara-Client', @@ -195,7 +195,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -211,7 +211,7 @@ def __set_configuration(self, api_client): 'auth': [ 'Bearer' ], - 'endpoint_path': '/einvoicing/webhooks/subscriptions/{subscription-id}', + 'endpoint_path': '/einvoicing/webhooks/subscriptions/{subscriptionId}', 'operation_id': 'get_webhook_subscription', 'http_method': 'GET', 'servers': None, @@ -250,7 +250,7 @@ def __set_configuration(self, api_client): (str,), }, 'attribute_map': { - 'subscription_id': 'subscription-id', + 'subscription_id': 'subscriptionId', 'avalara_version': 'avalara-version', 'x_correlation_id': 'X-Correlation-ID', 'x_avalara_client': 'X-Avalara-Client', @@ -265,7 +265,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -349,7 +349,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -369,7 +369,7 @@ def create_webhook_subscription( ): """Create a subscription to events # noqa: E501 - Create a subscription to events exposed by registered systems. # noqa: E501 + Create a new webhook subscription and return the created subscription details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -377,7 +377,7 @@ def create_webhook_subscription( >>> result = thread.get() Args: - avalara_version (str): The version of the API to use, e.g., \"1.4\". + avalara_version (str): The version of the API to use, e.g., \"1.6\". subscription_registration (SubscriptionRegistration): Keyword Args: @@ -441,7 +441,7 @@ def delete_webhook_subscription( ): """Unsubscribe from events # noqa: E501 - Remove a subscription from the webhooks dispatch service. All events and subscriptions are also deleted. # noqa: E501 + Delete the specified webhook subscription. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -449,8 +449,8 @@ def delete_webhook_subscription( >>> result = thread.get() Args: - subscription_id (str): - avalara_version (str): The version of the API to use, e.g., \"1.4\". + subscription_id (str): Unique identifier of the subscription. + avalara_version (str): The version of the API to use, e.g., \"1.6\". Keyword Args: x_correlation_id (str): A unique identifier for tracking the request and its response. [optional] @@ -521,8 +521,8 @@ def get_webhook_subscription( >>> result = thread.get() Args: - subscription_id (str): - avalara_version (str): The version of the API to use, e.g., \"1.4\". + subscription_id (str): Unique identifier of the subscription. + avalara_version (str): The version of the API to use, e.g., \"1.6\". Keyword Args: x_correlation_id (str): A unique identifier for tracking the request and its response. [optional] @@ -584,7 +584,7 @@ def list_webhook_subscriptions( ): """List all subscriptions # noqa: E501 - Retrieve a list of all subscriptions. # noqa: E501 + Retrieve a list of webhook subscriptions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -592,7 +592,7 @@ def list_webhook_subscriptions( >>> result = thread.get() Args: - avalara_version (str): The version of the API to use, e.g., \"1.4\". + avalara_version (str): The version of the API to use, e.g., \"1.6\". Keyword Args: x_correlation_id (str): A unique identifier for tracking the request and its response. [optional] diff --git a/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py b/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py index 5a741d6..ff89f5a 100644 --- a/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/tax_identifiers_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -60,7 +60,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.tax_identifier_schema_by_country_endpoint = _Endpoint( @@ -134,7 +134,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -203,7 +203,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -223,9 +223,9 @@ def tax_identifier_schema_by_country( country_code, **kwargs ): - """Returns the tax identifier request & response schema for a specific country. # noqa: E501 + """Returns the tax identifier request and response schema for a specific country. # noqa: E501 - This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority. # noqa: E501 + Returns the tax identifier request and response schema for a specific country. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -233,13 +233,13 @@ def tax_identifier_schema_by_country( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - country_code (str): The two-letter ISO-3166 country code for which the schema should be retrieved. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + country_code (str): Two-letter ISO 3166 country code for which to retrieve the schema (for example \"DE\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] - type (str): Specifies whether to return the request or response schema.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] + type (str): Specifies which schema to return: \"request\" to receive the request validation schema or \"response\" to receive the response validation schema.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -306,12 +306,12 @@ def validate_tax_identifier( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). tax_identifier_request (TaxIdentifierRequest): Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py b/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py index 04c12df..ca70e5b 100644 --- a/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py +++ b/Avalara/SDK/api/EInvoicing/V1/trading_partners_api.py @@ -22,7 +22,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -66,7 +66,7 @@ def __verify_api_client(self,api_client): def __set_configuration(self, api_client): self.__verify_api_client(api_client) - api_client.set_sdk_version("25.11.2") + api_client.set_sdk_version("26.4.0") self.api_client = api_client self.batch_search_participants_endpoint = _Endpoint( @@ -141,7 +141,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -212,7 +212,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -283,7 +283,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -355,7 +355,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -425,7 +425,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'text/csv', 'application/json' @@ -496,7 +496,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -585,7 +585,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -680,7 +680,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -755,7 +755,7 @@ def __set_configuration(self, api_client): } }, headers_map={ - 'avalara-version': '1.4', + 'avalara-version': '1.6', 'accept': [ 'application/json' ], @@ -787,14 +787,14 @@ def batch_search_participants( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - name (str): A human-readable name for the batch search. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + name (str): A human-readable name for the batch search. notification_email (str): The email address to which a notification will be sent once the batch search is complete. file (bytearray): CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -863,12 +863,12 @@ def create_trading_partner( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). trading_partner (TradingPartner): Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -927,7 +927,7 @@ def create_trading_partners_batch( ): """Creates a batch of multiple trading partners. # noqa: E501 - This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed. # noqa: E501 + This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or a 1 MB request payload. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -935,12 +935,12 @@ def create_trading_partners_batch( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). create_trading_partners_batch_request (CreateTradingPartnersBatchRequest): Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1007,12 +1007,12 @@ def delete_trading_partner( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - id (str): The ID of the trading partner which is being deleted. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + id (str): Unique identifier of the trading partner. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1079,12 +1079,12 @@ def download_batch_search_report( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - id (str): The ID of the batch search for which the report should be downloaded. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + id (str): Unique identifier of the batch search for which to download the report. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1151,12 +1151,12 @@ def get_batch_search_detail( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - id (str): The ID of the batch search that was submitted earlier. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + id (str): Unique identifier of the batch search. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1222,16 +1222,16 @@ def list_batch_searches( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - filter (str): Filters the results by field name. Only the eq operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/).. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + filter (str): Filters the results by field name. Only the eq operator and the name field are supported. For more information, refer to the Avalara filtering guide.. [optional] count (bool): When set to true, returns the total count of matching records included as @recordSetCount in the response body.. [optional] top (int): The number of items to include in the result.. [optional] skip (int): The number of items to skip in the result.. [optional] order_by (str): The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1297,17 +1297,17 @@ def search_participants( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - search (str): Search by value supports logical AND / OR operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search). + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + search (str): Search by value supports logical AND and OR operators (case-sensitive). Search is performed only over the name and identifier value fields. For more information, refer to the OData query options overview documentation. Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - count (bool): When set to true, returns the total count of matching records included as @recordSetCount in the response body.. [optional] - filter (str): Filters the results using the eq operator. Supported fields: network, country, documentType, idType. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/).. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + count (bool): When set to true, returns the total count of matching records included as @recordSetCount in the response body.. [optional] + filter (str): Filters the results using the eq operator. Supported fields include network, country, documentType, and idType. For more information, refer to the Avalara filtering guide.. [optional] top (int): The number of items to include in the result.. [optional] skip (int): The number of items to skip in the result.. [optional] - order_by (str): The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + order_by (str): The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1375,13 +1375,13 @@ def update_trading_partner( >>> result = thread.get() Args: - avalara_version (str): The HTTP Header meant to specify the version of the API intended to be used. - id (str): The ID of the trading partner which is being updated. + avalara_version (str): Header that specifies the API version to use (for example \"1.6\"). + id (str): Unique identifier of the trading partner. trading_partner (TradingPartner): Keyword Args: - x_avalara_client (str): You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\".. [optional] - x_correlation_id (str): The caller can use this as an identifier to use as a correlation id to trace the call.. [optional] + x_avalara_client (str): Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").. [optional] + x_correlation_id (str): Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object diff --git a/Avalara/SDK/models/EInvoicing/V1/address.py b/Avalara/SDK/models/EInvoicing/V1/address.py index 7755ea5..01ecf3e 100644 --- a/Avalara/SDK/models/EInvoicing/V1/address.py +++ b/Avalara/SDK/models/EInvoicing/V1/address.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py b/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py index a29b91e..4b586a5 100644 --- a/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/bad_download_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/bad_request.py b/Avalara/SDK/models/EInvoicing/V1/bad_request.py index b0c1cdf..8e9df22 100644 --- a/Avalara/SDK/models/EInvoicing/V1/bad_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/bad_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py b/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py index 079f36b..26cd18a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_error_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search.py b/Avalara/SDK/models/EInvoicing/V1/batch_search.py index d2c636a..936a4aa 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py b/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py index 8215766..b2e15fe 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py b/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py index f59239b..af4b806 100644 --- a/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/batch_search_participants202_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/code_list_list_response.py b/Avalara/SDK/models/EInvoicing/V1/code_list_list_response.py new file mode 100644 index 0000000..3ad6bc1 --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/code_list_list_response.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.code_list_summary import CodeListSummary +from typing import Optional, Set +from typing_extensions import Self + +class CodeListListResponse(BaseModel): + """ + Returns the requested list of code lists + """ # noqa: E501 + recordset_count: Optional[StrictStr] = Field(default=None, description="Count of code lists for the given query parameters", alias="@recordsetCount") + next_link: Optional[StrictStr] = Field(default=None, alias="@nextLink") + value: List[CodeListSummary] = Field(description="Array of code lists matching query parameters") + __properties: ClassVar[List[str]] = ["@recordsetCount", "@nextLink", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CodeListListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in value (list) + _items = [] + if self.value: + for _item in self.value: + if _item: + _items.append(_item.to_dict()) + _dict['value'] = _items + # set to None if next_link (nullable) is None + # and model_fields_set contains the field + if self.next_link is None and "next_link" in self.model_fields_set: + _dict['@nextLink'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CodeListListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "@recordsetCount": obj.get("@recordsetCount"), + "@nextLink": obj.get("@nextLink"), + "value": [CodeListSummary.from_dict(_item) for _item in obj["value"]] if obj.get("value") is not None else None + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/code_list_response.py b/Avalara/SDK/models/EInvoicing/V1/code_list_response.py new file mode 100644 index 0000000..85e23fb --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/code_list_response.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.code_list_version import CodeListVersion +from typing import Optional, Set +from typing_extensions import Self + +class CodeListResponse(BaseModel): + """ + Returns a code list definition for a specific country + """ # noqa: E501 + country_code: Optional[StrictStr] = Field(default=None, description="Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to.", alias="countryCode") + code_list_id: Optional[StrictStr] = Field(default=None, description="System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs.", alias="codeListId") + code_list_name: Optional[StrictStr] = Field(default=None, description="Human-readable name of the code list, usually describing what the codes represent (for example, document types, tax categories, currencies).", alias="codeListName") + description: Optional[StrictStr] = Field(default=None, description="Textual description of the code list, including what it is used for and whether it represents a global standard (e.g., UN/CEFACT, ISO, EN16931) or a jurisdiction-specific/local extension of that standard.") + standard: Optional[StrictStr] = Field(default=None, description="Identifier of the underlying standard or authoritative source for this code list. This may be a formal code list name (e.g., UNCL1001), a standard reference (e.g., EN16931), or an internal standard identifier.") + versions: Optional[List[CodeListVersion]] = Field(default=None, description="Array of versioned definitions of this code list for the given jurisdiction. Each entry represents a version that is valid for a specific effective/sunset date range, optionally per locale.") + __properties: ClassVar[List[str]] = ["countryCode", "codeListId", "codeListName", "description", "standard", "versions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CodeListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in versions (list) + _items = [] + if self.versions: + for _item in self.versions: + if _item: + _items.append(_item.to_dict()) + _dict['versions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CodeListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "countryCode": obj.get("countryCode"), + "codeListId": obj.get("codeListId"), + "codeListName": obj.get("codeListName"), + "description": obj.get("description"), + "standard": obj.get("standard"), + "versions": [CodeListVersion.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/code_list_summary.py b/Avalara/SDK/models/EInvoicing/V1/code_list_summary.py new file mode 100644 index 0000000..ad9df7a --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/code_list_summary.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.code_list_version import CodeListVersion +from typing import Optional, Set +from typing_extensions import Self + +class CodeListSummary(BaseModel): + """ + Displays a summary of information about a code list + """ # noqa: E501 + country_code: Optional[StrictStr] = Field(default=None, description="Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to.", alias="countryCode") + code_list_id: Optional[StrictStr] = Field(default=None, description="System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs.", alias="codeListId") + code_list_name: Optional[StrictStr] = Field(default=None, description="Human-readable name of the code list, usually describing what the codes represent (for example, document types, tax categories, currencies).", alias="codeListName") + description: Optional[StrictStr] = Field(default=None, description="Textual description of the code list, including what it is used for and whether it represents a global standard (e.g., UN/CEFACT, ISO, EN16931) or a jurisdiction-specific/local extension of that standard.") + standard: Optional[StrictStr] = Field(default=None, description="Identifier of the underlying standard or authoritative source for this code list. This may be a formal code list name (e.g., UNCL1001), a standard reference (e.g., EN16931), or an internal standard identifier.") + versions: Optional[List[CodeListVersion]] = Field(default=None, description="Array of versioned definitions of this code list for the given jurisdiction. Each entry represents a version that is valid for a specific effective/sunset date range, optionally per locale.") + __properties: ClassVar[List[str]] = ["countryCode", "codeListId", "codeListName", "description", "standard", "versions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CodeListSummary from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in versions (list) + _items = [] + if self.versions: + for _item in self.versions: + if _item: + _items.append(_item.to_dict()) + _dict['versions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CodeListSummary from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "countryCode": obj.get("countryCode"), + "codeListId": obj.get("codeListId"), + "codeListName": obj.get("codeListName"), + "description": obj.get("description"), + "standard": obj.get("standard"), + "versions": [CodeListVersion.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/code_list_value.py b/Avalara/SDK/models/EInvoicing/V1/code_list_value.py new file mode 100644 index 0000000..09f0ab1 --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/code_list_value.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CodeListValue(BaseModel): + """ + Represents a single code entry in a code list version + """ # noqa: E501 + code: Optional[StrictStr] = Field(default=None, description="The actual code value used in documents or systems. This is typically what appears in the e-invoice payload, such as a numeric or alphanumeric code from the official code list.") + value: Optional[StrictStr] = Field(default=None, description="Human-readable label or name for the code, localized according to the locale field of the version.") + description: Optional[StrictStr] = Field(default=None, description="Detailed explanation of what the code represents, localized according to the locale field of the version.") + __properties: ClassVar[List[str]] = ["code", "value", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CodeListValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CodeListValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "code": obj.get("code"), + "value": obj.get("value"), + "description": obj.get("description") + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/code_list_version.py b/Avalara/SDK/models/EInvoicing/V1/code_list_version.py new file mode 100644 index 0000000..4777abc --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/code_list_version.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.code_list_value import CodeListValue +from typing import Optional, Set +from typing_extensions import Self + +class CodeListVersion(BaseModel): + """ + Represents a versioned definition of a code list for a specific jurisdiction and date range + """ # noqa: E501 + version_reasons: Optional[List[StrictStr]] = Field(default=None, description="List of free-text reasons explaining why this version of the code list exists (for example, initial introduction, regulatory update, addition/deprecation of codes). Useful for audit and change tracking.", alias="versionReasons") + juris_effective_date: Optional[date] = Field(default=None, description="Date from which this version of the code list becomes legally or operationally effective in the jurisdiction. Typically corresponds to a go-live, mandate, or release date.", alias="jurisEffectiveDate") + juris_sunset_date: Optional[date] = Field(default=None, description="Date after which this version of the code list must no longer be used in the jurisdiction. Use a far-future date (e.g., 9999-12-31) when the sunset is not yet known.", alias="jurisSunsetDate") + locale: Optional[StrictStr] = Field(default=None, description="Language–region locale identifier indicating the language and regional variant for descriptions in this version of the code list. Follows BCP-47 format such as en-US, fr-FR, de-DE.") + values: Optional[List[CodeListValue]] = Field(default=None, description="Array of code entries defined in this version of the code list. Each entry contains the machine-readable code value and its human-readable description in the given locale.") + __properties: ClassVar[List[str]] = ["versionReasons", "jurisEffectiveDate", "jurisSunsetDate", "locale", "values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CodeListVersion from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in values (list) + _items = [] + if self.values: + for _item in self.values: + if _item: + _items.append(_item.to_dict()) + _dict['values'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CodeListVersion from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "versionReasons": obj.get("versionReasons"), + "jurisEffectiveDate": obj.get("jurisEffectiveDate"), + "jurisSunsetDate": obj.get("jurisSunsetDate"), + "locale": obj.get("locale"), + "values": [CodeListValue.from_dict(_item) for _item in obj["values"]] if obj.get("values") is not None else None + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py b/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py index eae581f..2f3e49c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/conditional_for_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/consents.py b/Avalara/SDK/models/EInvoicing/V1/consents.py index fc75176..5a58842 100644 --- a/Avalara/SDK/models/EInvoicing/V1/consents.py +++ b/Avalara/SDK/models/EInvoicing/V1/consents.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py index 7fb0d01..3934560 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partner201_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py index 4ea556d..d601d81 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py index ff2f24b..9a9c9df 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch200_response_value_inner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py index 46f27bf..8c4040e 100644 --- a/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/create_trading_partners_batch_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field.py index ac1ad8a..2798bf9 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py index 130fea4..c09cb3c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_not_used_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py index 221506a..1ce3bf3 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_optional_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py b/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py index d36db40..e7f893f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_field_required_for.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py b/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py index 1fe888d..2b62808 100644 --- a/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/data_input_fields_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_fetch.py b/Avalara/SDK/models/EInvoicing/V1/document_fetch.py index 8e5f9a0..1b9a1c7 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_fetch.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_fetch.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_list_response.py b/Avalara/SDK/models/EInvoicing/V1/document_list_response.py index 410663f..25bb9c6 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_status_response.py b/Avalara/SDK/models/EInvoicing/V1/document_status_response.py index e5111bc..e05b2a9 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_status_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_status_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -44,9 +44,10 @@ class DocumentStatusResponse(BaseModel): Returns the current document ID and status """ # noqa: E501 id: Optional[StrictStr] = Field(default=None, description="The unique ID for this document") - status: Optional[StrictStr] = Field(default=None, description="Status of the document") + status: Optional[StrictStr] = Field(default=None, description="Document status. See the `supportedDocumentStatuses` field in the GET /mandates response for full status definitions.") + business_status: Optional[StrictStr] = Field(default=None, description="Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation.", alias="businessStatus") events: Optional[List[StatusEvent]] = None - __properties: ClassVar[List[str]] = ["id", "status", "events"] + __properties: ClassVar[List[str]] = ["id", "status", "businessStatus", "events"] model_config = ConfigDict( populate_by_name=True, @@ -108,6 +109,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "id": obj.get("id"), "status": obj.get("status"), + "businessStatus": obj.get("businessStatus"), "events": [StatusEvent.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py b/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py index bbc23ae..7af08ff 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_submission_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py b/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py index 941cffa..261b83b 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_submit_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/document_summary.py b/Avalara/SDK/models/EInvoicing/V1/document_summary.py index decd450..53d3194 100644 --- a/Avalara/SDK/models/EInvoicing/V1/document_summary.py +++ b/Avalara/SDK/models/EInvoicing/V1/document_summary.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -35,6 +35,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.status_event import StatusEvent from typing import Optional, Set from typing_extensions import Self @@ -46,6 +47,7 @@ class DocumentSummary(BaseModel): company_id: Optional[StrictStr] = Field(default=None, description="Unique identifier that represents the company within the system.", alias="companyId") process_date_time: Optional[StrictStr] = Field(default=None, description="The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss", alias="processDateTime") status: Optional[StrictStr] = Field(default=None, description="The Document status") + business_status: Optional[StrictStr] = Field(default=None, description="Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation.", alias="businessStatus") supplier_name: Optional[StrictStr] = Field(default=None, description="The name of the supplier in the transaction", alias="supplierName") customer_name: Optional[StrictStr] = Field(default=None, description="The name of the customer in the transaction", alias="customerName") document_type: Optional[StrictStr] = Field(default=None, description="The document type", alias="documentType") @@ -57,7 +59,10 @@ class DocumentSummary(BaseModel): country_mandate: Optional[StrictStr] = Field(default=None, description="The e-invoicing mandate for the specified country", alias="countryMandate") interface: Optional[StrictStr] = Field(default=None, description="The interface where the document is sent") receiver: Optional[StrictStr] = Field(default=None, description="The document recipient based on the interface") - __properties: ClassVar[List[str]] = ["id", "companyId", "processDateTime", "status", "supplierName", "customerName", "documentType", "documentVersion", "documentNumber", "documentDate", "flow", "countryCode", "countryMandate", "interface", "receiver"] + events: Optional[List[StatusEvent]] = Field(default=None, description="Array of status events associated with this document. Events are included in each document in the response only when the query parameter $include=events is passed; otherwise the events array is not populated.") + created_at: Optional[StrictStr] = Field(default=None, description="The date and time when the document was created in the system, displayed in ISO 8601 format with timezone", alias="createdAt") + last_updated_at: Optional[StrictStr] = Field(default=None, description="The date and time when the document was last updated in the system, displayed in ISO 8601 format with timezone", alias="lastUpdatedAt") + __properties: ClassVar[List[str]] = ["id", "companyId", "processDateTime", "status", "businessStatus", "supplierName", "customerName", "documentType", "documentVersion", "documentNumber", "documentDate", "flow", "countryCode", "countryMandate", "interface", "receiver", "events", "createdAt", "lastUpdatedAt"] model_config = ConfigDict( populate_by_name=True, @@ -98,6 +103,18 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of each item in events (list) + _items = [] + if self.events: + for _item in self.events: + if _item: + _items.append(_item.to_dict()) + _dict['events'] = _items + # set to None if events (nullable) is None + # and model_fields_set contains the field + if self.events is None and "events" in self.model_fields_set: + _dict['events'] = None + return _dict @classmethod @@ -114,6 +131,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "companyId": obj.get("companyId"), "processDateTime": obj.get("processDateTime"), "status": obj.get("status"), + "businessStatus": obj.get("businessStatus"), "supplierName": obj.get("supplierName"), "customerName": obj.get("customerName"), "documentType": obj.get("documentType"), @@ -124,7 +142,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "countryCode": obj.get("countryCode"), "countryMandate": obj.get("countryMandate"), "interface": obj.get("interface"), - "receiver": obj.get("receiver") + "receiver": obj.get("receiver"), + "events": [StatusEvent.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None, + "createdAt": obj.get("createdAt"), + "lastUpdatedAt": obj.get("lastUpdatedAt") }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/error_response.py b/Avalara/SDK/models/EInvoicing/V1/error_response.py index 30838be..307bc06 100644 --- a/Avalara/SDK/models/EInvoicing/V1/error_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/error_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_id.py b/Avalara/SDK/models/EInvoicing/V1/event_id.py index 54663b3..e0581b3 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_id.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_id.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_message.py b/Avalara/SDK/models/EInvoicing/V1/event_message.py index 23e3692..bac8ea3 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_message.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_message.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_payload.py b/Avalara/SDK/models/EInvoicing/V1/event_payload.py index cc4e3d5..fd60414 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_payload.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_payload.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/event_subscription.py b/Avalara/SDK/models/EInvoicing/V1/event_subscription.py index d5eab2a..0a14735 100644 --- a/Avalara/SDK/models/EInvoicing/V1/event_subscription.py +++ b/Avalara/SDK/models/EInvoicing/V1/event_subscription.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/extension.py b/Avalara/SDK/models/EInvoicing/V1/extension.py index dabee5d..99dfb0c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/extension.py +++ b/Avalara/SDK/models/EInvoicing/V1/extension.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py index 6a9e0f9..bb7fc29 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py index 27fbfc6..b10bb80 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_data_inner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py index af8a123..ed9e49b 100644 --- a/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py +++ b/Avalara/SDK/models/EInvoicing/V1/fetch_documents_request_metadata.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py b/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py index 5815f20..c2011d3 100644 --- a/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/forbidden_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py b/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py index 7c796e7..584a006 100644 --- a/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/hmac_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py b/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py index 9b58a5a..baf0cdc 100644 --- a/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/hmac_signature_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/id.py b/Avalara/SDK/models/EInvoicing/V1/id.py index 7e13f4a..a230aef 100644 --- a/Avalara/SDK/models/EInvoicing/V1/id.py +++ b/Avalara/SDK/models/EInvoicing/V1/id.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/identifier.py b/Avalara/SDK/models/EInvoicing/V1/identifier.py index f276bc3..f0a5f98 100644 --- a/Avalara/SDK/models/EInvoicing/V1/identifier.py +++ b/Avalara/SDK/models/EInvoicing/V1/identifier.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -36,6 +36,7 @@ from pydantic import BaseModel, ConfigDict, Field from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from Avalara.SDK.models.EInvoicing.V1.extension import Extension from typing import Optional, Set from typing_extensions import Self @@ -46,7 +47,8 @@ class Identifier(BaseModel): name: Annotated[str, Field(strict=True, max_length=250)] = Field(description="Identifier name (e.g., Peppol Participant ID).") display_name: Optional[Annotated[str, Field(strict=True, max_length=250)]] = Field(default=None, description="Display name of the identifier.", alias="displayName") value: Annotated[str, Field(strict=True, max_length=250)] = Field(description="Value of the identifier.") - __properties: ClassVar[List[str]] = ["name", "displayName", "value"] + extensions: Optional[List[Extension]] = Field(default=None, description="Optional array used to carry additional metadata or configuration values for the identifier.") + __properties: ClassVar[List[str]] = ["name", "displayName", "value", "extensions"] model_config = ConfigDict( populate_by_name=True, @@ -87,6 +89,13 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of each item in extensions (list) + _items = [] + if self.extensions: + for _item in self.extensions: + if _item: + _items.append(_item.to_dict()) + _dict['extensions'] = _items return _dict @classmethod @@ -101,7 +110,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "name": obj.get("name"), "displayName": obj.get("displayName"), - "value": obj.get("value") + "value": obj.get("value"), + "extensions": [Extension.from_dict(_item) for _item in obj["extensions"]] if obj.get("extensions") is not None else None }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py b/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py index 30b3d48..c677681 100644 --- a/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py +++ b/Avalara/SDK/models/EInvoicing/V1/input_data_formats.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py b/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py index 8102732..d216bf0 100644 --- a/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/internal_server_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate.py b/Avalara/SDK/models/EInvoicing/V1/mandate.py index 291f864..8f07723 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -37,6 +37,7 @@ from typing import Any, ClassVar, Dict, List, Optional from Avalara.SDK.models.EInvoicing.V1.input_data_formats import InputDataFormats from Avalara.SDK.models.EInvoicing.V1.output_data_formats import OutputDataFormats +from Avalara.SDK.models.EInvoicing.V1.supported_document_statuses import SupportedDocumentStatuses from Avalara.SDK.models.EInvoicing.V1.workflow_ids import WorkflowIds from typing import Optional, Set from typing_extensions import Self @@ -58,7 +59,8 @@ class Mandate(BaseModel): input_data_formats: Optional[List[InputDataFormats]] = Field(default=None, description="Format and version used when inputting the data", alias="inputDataFormats") output_data_formats: Optional[List[OutputDataFormats]] = Field(default=None, description="Lists the supported output document formats for the country mandate. For countries where specifying an output document format is required (e.g., France), this array will contain the applicable formats. For other countries where output format selection is not necessary, the array will be empty.", alias="outputDataFormats") workflow_ids: Optional[List[WorkflowIds]] = Field(default=None, description="Workflow ID list", alias="workflowIds") - __properties: ClassVar[List[str]] = ["mandateId", "countryMandate", "countryCode", "description", "supportedByELRAPI", "mandateFormat", "eInvoicingFlow", "eInvoicingFlowDocumentationLink", "getInvoiceAvailableMediaType", "supportsInboundDigitalDocument", "inputDataFormats", "outputDataFormats", "workflowIds"] + supported_document_statuses: Optional[List[SupportedDocumentStatuses]] = Field(default=None, description="List of document statuses defined by the mandate.", alias="supportedDocumentStatuses") + __properties: ClassVar[List[str]] = ["mandateId", "countryMandate", "countryCode", "description", "supportedByELRAPI", "mandateFormat", "eInvoicingFlow", "eInvoicingFlowDocumentationLink", "getInvoiceAvailableMediaType", "supportsInboundDigitalDocument", "inputDataFormats", "outputDataFormats", "workflowIds", "supportedDocumentStatuses"] model_config = ConfigDict( populate_by_name=True, @@ -120,6 +122,13 @@ def to_dict(self) -> Dict[str, Any]: if _item: _items.append(_item.to_dict()) _dict['workflowIds'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in supported_document_statuses (list) + _items = [] + if self.supported_document_statuses: + for _item in self.supported_document_statuses: + if _item: + _items.append(_item.to_dict()) + _dict['supportedDocumentStatuses'] = _items return _dict @classmethod @@ -144,7 +153,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "supportsInboundDigitalDocument": obj.get("supportsInboundDigitalDocument"), "inputDataFormats": [InputDataFormats.from_dict(_item) for _item in obj["inputDataFormats"]] if obj.get("inputDataFormats") is not None else None, "outputDataFormats": [OutputDataFormats.from_dict(_item) for _item in obj["outputDataFormats"]] if obj.get("outputDataFormats") is not None else None, - "workflowIds": [WorkflowIds.from_dict(_item) for _item in obj["workflowIds"]] if obj.get("workflowIds") is not None else None + "workflowIds": [WorkflowIds.from_dict(_item) for _item in obj["workflowIds"]] if obj.get("workflowIds") is not None else None, + "supportedDocumentStatuses": [SupportedDocumentStatuses.from_dict(_item) for _item in obj["supportedDocumentStatuses"]] if obj.get("supportedDocumentStatuses") is not None else None }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py index a3c6b3f..dc243d2 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py index 5b1a3c6..c339923 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandate_data_input_field_namespace.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/mandates_response.py b/Avalara/SDK/models/EInvoicing/V1/mandates_response.py index 16abe5f..da67643 100644 --- a/Avalara/SDK/models/EInvoicing/V1/mandates_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/mandates_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/not_found_error.py b/Avalara/SDK/models/EInvoicing/V1/not_found_error.py index 27e9a96..343b906 100644 --- a/Avalara/SDK/models/EInvoicing/V1/not_found_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/not_found_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py b/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py index 29c0769..e8f69ee 100644 --- a/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/not_used_for_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py b/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py index a6893dd..28b6efa 100644 --- a/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py +++ b/Avalara/SDK/models/EInvoicing/V1/output_data_formats.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/pagination.py b/Avalara/SDK/models/EInvoicing/V1/pagination.py index 78df85a..6bd8083 100644 --- a/Avalara/SDK/models/EInvoicing/V1/pagination.py +++ b/Avalara/SDK/models/EInvoicing/V1/pagination.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/report_download_response.py b/Avalara/SDK/models/EInvoicing/V1/report_download_response.py new file mode 100644 index 0000000..755e38b --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/report_download_response.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ReportDownloadResponse(BaseModel): + """ + Returns a pre-signed URL to download the report file. + """ # noqa: E501 + report_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the report.", alias="reportId") + download_url: Optional[StrictStr] = Field(default=None, description="A pre-signed URL to download the report file. This URL is time-limited.", alias="downloadUrl") + __properties: ClassVar[List[str]] = ["reportId", "downloadUrl"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReportDownloadResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReportDownloadResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "reportId": obj.get("reportId"), + "downloadUrl": obj.get("downloadUrl") + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/report_item.py b/Avalara/SDK/models/EInvoicing/V1/report_item.py new file mode 100644 index 0000000..984d69f --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/report_item.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class ReportItem(BaseModel): + """ + Represents a single report with full details including metadata and associated transaction IDs. + """ # noqa: E501 + report_id: Optional[StrictStr] = Field(default=None, description="The unique ID for this report.", alias="reportId") + job_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the job that generated this report.", alias="jobId") + report_generate_date: Optional[datetime] = Field(default=None, description="The date and time when the report was generated.", alias="reportGenerateDate") + report_from: Optional[date] = Field(default=None, description="The start date of the reporting period.", alias="reportFrom") + report_to: Optional[date] = Field(default=None, description="The end date of the reporting period.", alias="reportTo") + country_code: Optional[StrictStr] = Field(default=None, description="The two-letter ISO-3166 country code for which this report was generated.", alias="countryCode") + country_mandate: Optional[StrictStr] = Field(default=None, description="The e-invoicing mandate for the specified country.", alias="countryMandate") + document_type: Optional[StrictStr] = Field(default=None, description="The type of document covered by this report.", alias="documentType") + document_sub_type: Optional[StrictStr] = Field(default=None, description="The sub-type of the document.", alias="documentSubType") + report_reference: Optional[StrictStr] = Field(default=None, description="An internal reference path for the report.", alias="reportReference") + report_name: Optional[StrictStr] = Field(default=None, description="The name of the report file.", alias="reportName") + status: Optional[StrictStr] = Field(default=None, description="The current status of the report. Possible values include: PENDING, PROCESSING, COMPLETED, FAILED, SENT_TO_PPF, ERROR.") + report_format_mimetypes: Optional[StrictStr] = Field(default=None, description="The MIME type of the report file.", alias="reportFormatMimetypes") + tenant_id: Optional[StrictStr] = Field(default=None, description="The tenant identifier associated with this report.", alias="tenantId") + ta_name: Optional[StrictStr] = Field(default=None, description="The name of the tax authority for this report.", alias="taName") + tax_invoice_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The total invoice amount covered by this report.", alias="taxInvoiceAmount") + total_tax_amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The total tax amount covered by this report.", alias="totalTaxAmount") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Additional report metadata (free-form JSON). Contents vary by country mandate.") + transaction_ids: Optional[List[StrictStr]] = Field(default=None, description="List of transaction IDs associated with this report.", alias="transactionIds") + __properties: ClassVar[List[str]] = ["reportId", "jobId", "reportGenerateDate", "reportFrom", "reportTo", "countryCode", "countryMandate", "documentType", "documentSubType", "reportReference", "reportName", "status", "reportFormatMimetypes", "tenantId", "taName", "taxInvoiceAmount", "totalTaxAmount", "metadata", "transactionIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReportItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if job_id (nullable) is None + # and model_fields_set contains the field + if self.job_id is None and "job_id" in self.model_fields_set: + _dict['jobId'] = None + + # set to None if report_from (nullable) is None + # and model_fields_set contains the field + if self.report_from is None and "report_from" in self.model_fields_set: + _dict['reportFrom'] = None + + # set to None if report_to (nullable) is None + # and model_fields_set contains the field + if self.report_to is None and "report_to" in self.model_fields_set: + _dict['reportTo'] = None + + # set to None if document_type (nullable) is None + # and model_fields_set contains the field + if self.document_type is None and "document_type" in self.model_fields_set: + _dict['documentType'] = None + + # set to None if document_sub_type (nullable) is None + # and model_fields_set contains the field + if self.document_sub_type is None and "document_sub_type" in self.model_fields_set: + _dict['documentSubType'] = None + + # set to None if report_reference (nullable) is None + # and model_fields_set contains the field + if self.report_reference is None and "report_reference" in self.model_fields_set: + _dict['reportReference'] = None + + # set to None if tax_invoice_amount (nullable) is None + # and model_fields_set contains the field + if self.tax_invoice_amount is None and "tax_invoice_amount" in self.model_fields_set: + _dict['taxInvoiceAmount'] = None + + # set to None if total_tax_amount (nullable) is None + # and model_fields_set contains the field + if self.total_tax_amount is None and "total_tax_amount" in self.model_fields_set: + _dict['totalTaxAmount'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReportItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "reportId": obj.get("reportId"), + "jobId": obj.get("jobId"), + "reportGenerateDate": obj.get("reportGenerateDate"), + "reportFrom": obj.get("reportFrom"), + "reportTo": obj.get("reportTo"), + "countryCode": obj.get("countryCode"), + "countryMandate": obj.get("countryMandate"), + "documentType": obj.get("documentType"), + "documentSubType": obj.get("documentSubType"), + "reportReference": obj.get("reportReference"), + "reportName": obj.get("reportName"), + "status": obj.get("status"), + "reportFormatMimetypes": obj.get("reportFormatMimetypes"), + "tenantId": obj.get("tenantId"), + "taName": obj.get("taName"), + "taxInvoiceAmount": obj.get("taxInvoiceAmount"), + "totalTaxAmount": obj.get("totalTaxAmount"), + "metadata": obj.get("metadata"), + "transactionIds": obj.get("transactionIds") + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/report_list_response.py b/Avalara/SDK/models/EInvoicing/V1/report_list_response.py new file mode 100644 index 0000000..8535c50 --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/report_list_response.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from Avalara.SDK.models.EInvoicing.V1.report_item import ReportItem +from typing import Optional, Set +from typing_extensions import Self + +class ReportListResponse(BaseModel): + """ + Returns the requested list of reports matching the query parameters. + """ # noqa: E501 + recordset_count: Optional[StrictStr] = Field(default=None, description="Count of reports matching the filter for the given query. Present when the request includes $count=true.", alias="@recordsetCount") + next_link: Optional[StrictStr] = Field(default=None, description="URL to retrieve the next page of results when more items match the query. Omitted or null when there is no next page.", alias="@nextLink") + value: List[ReportItem] = Field(description="Array of reports matching the query parameters.") + __properties: ClassVar[List[str]] = ["@recordsetCount", "@nextLink", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReportListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in value (list) + _items = [] + if self.value: + for _item in self.value: + if _item: + _items.append(_item.to_dict()) + _dict['value'] = _items + # set to None if next_link (nullable) is None + # and model_fields_set contains the field + if self.next_link is None and "next_link" in self.model_fields_set: + _dict['@nextLink'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReportListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "@recordsetCount": obj.get("@recordsetCount"), + "@nextLink": obj.get("@nextLink"), + "value": [ReportItem.from_dict(_item) for _item in obj["value"]] if obj.get("value") is not None else None + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/required_when_field.py b/Avalara/SDK/models/EInvoicing/V1/required_when_field.py index ce07213..03a0a52 100644 --- a/Avalara/SDK/models/EInvoicing/V1/required_when_field.py +++ b/Avalara/SDK/models/EInvoicing/V1/required_when_field.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py b/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py index a68be69..1ca2f06 100644 --- a/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/search_participants200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature.py b/Avalara/SDK/models/EInvoicing/V1/signature.py index cfbdf63..937806a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_signature.py b/Avalara/SDK/models/EInvoicing/V1/signature_signature.py index d76d0ac..8a80eeb 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_value.py b/Avalara/SDK/models/EInvoicing/V1/signature_value.py index 5e28cfc..cd6042c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py b/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py index 2e2ff09..a3befec 100644 --- a/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py +++ b/Avalara/SDK/models/EInvoicing/V1/signature_value_signature.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/status_event.py b/Avalara/SDK/models/EInvoicing/V1/status_event.py index 239c1d1..8e0fc23 100644 --- a/Avalara/SDK/models/EInvoicing/V1/status_event.py +++ b/Avalara/SDK/models/EInvoicing/V1/status_event.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -42,11 +42,12 @@ class StatusEvent(BaseModel): """ Displays when a status event occurred """ # noqa: E501 - event_date_time: Optional[StrictStr] = Field(default=None, description="The date and time when the status event occured, displayed in the format YYYY-MM-DDThh:mm:ss", alias="eventDateTime") + event_date_time: Optional[StrictStr] = Field(default=None, description="The date and time when the status event occurred, displayed in the format YYYY-MM-DDThh:mm:ss", alias="eventDateTime") message: Optional[StrictStr] = Field(default=None, description="A message describing the status event") response_key: Optional[StrictStr] = Field(default=None, description=" The type of number or acknowledgement returned by the tax authority (if applicable). For example, it could be an identification key, acknowledgement code, or any other relevant identifier.", alias="responseKey") response_value: Optional[StrictStr] = Field(default=None, description="The corresponding value associated with the response key. This value is provided by the tax authority in response to the event.", alias="responseValue") - __properties: ClassVar[List[str]] = ["eventDateTime", "message", "responseKey", "responseValue"] + category: Optional[StrictStr] = Field(default=None, description="Represents the functional area or process stage where the status event occurred. Useful for grouping related events such as document processing, transmission, or validation.") + __properties: ClassVar[List[str]] = ["eventDateTime", "message", "responseKey", "responseValue", "category"] model_config = ConfigDict( populate_by_name=True, @@ -97,6 +98,11 @@ def to_dict(self) -> Dict[str, Any]: if self.response_value is None and "response_value" in self.model_fields_set: _dict['responseValue'] = None + # set to None if category (nullable) is None + # and model_fields_set contains the field + if self.category is None and "category" in self.model_fields_set: + _dict['category'] = None + return _dict @classmethod @@ -112,7 +118,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "eventDateTime": obj.get("eventDateTime"), "message": obj.get("message"), "responseKey": obj.get("responseKey"), - "responseValue": obj.get("responseValue") + "responseValue": obj.get("responseValue"), + "category": obj.get("category") }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py b/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py index 1937c24..b1cf4dd 100644 --- a/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py +++ b/Avalara/SDK/models/EInvoicing/V1/submit_document_metadata.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py b/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py index 4c7fc6d..becda0f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/submit_interop_document202_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_common.py b/Avalara/SDK/models/EInvoicing/V1/subscription_common.py index f76fe3d..f1637a4 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_common.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_common.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py b/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py index 2cf0ce5..d817742 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_detail.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py b/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py index b491d34..5380c9a 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_list_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py b/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py index fcffe82..162db39 100644 --- a/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py +++ b/Avalara/SDK/models/EInvoicing/V1/subscription_registration.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/success_response.py b/Avalara/SDK/models/EInvoicing/V1/success_response.py index c354c8e..76dacab 100644 --- a/Avalara/SDK/models/EInvoicing/V1/success_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/success_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/supported_document_statuses.py b/Avalara/SDK/models/EInvoicing/V1/supported_document_statuses.py new file mode 100644 index 0000000..57a8b59 --- /dev/null +++ b/Avalara/SDK/models/EInvoicing/V1/supported_document_statuses.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" +AvaTax Software Development Kit for Python. + + Copyright 2022 Avalara, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. + +@author Sachin Baijal +@author Jonathan Wenger +@copyright 2022 Avalara, Inc. +@license https://www.apache.org/licenses/LICENSE-2.0 +@version 26.4.0 +@link https://github.com/avadev/AvaTax-REST-V3-Python-SDK +""" + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SupportedDocumentStatuses(BaseModel): + """ + Represents a document status defined by the mandate. + """ # noqa: E501 + status: Optional[StrictStr] = Field(default=None, description="The name of the status (e.g., Approved, Fully Paid).") + description: Optional[StrictStr] = Field(default=None, description="Explanation of what the status means.") + __properties: ClassVar[List[str]] = ["status", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SupportedDocumentStatuses from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SupportedDocumentStatuses from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "status": obj.get("status"), + "description": obj.get("description") + }) + return _obj + + diff --git a/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py b/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py index bcd756c..afd628f 100644 --- a/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py +++ b/Avalara/SDK/models/EInvoicing/V1/supported_document_types.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py index aac3117..89430b0 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_request.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py index 979a483..07f106c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py index 0e77ac3..42165f6 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_response_value.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py index d3f3778..51d4ef9 100644 --- a/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/tax_identifier_schema_by_country200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -43,8 +43,9 @@ class TaxIdentifierSchemaByCountry200Response(BaseModel): TaxIdentifierSchemaByCountry200Response """ # noqa: E501 country_code: StrictStr = Field(description="The two-letter ISO-3166 country code of the tax identifier.", alias="countryCode") + schema_type: StrictStr = Field(description="The type of schema returned: \"request\" or \"response\".", alias="schemaType") var_schema: Dict[str, Any] = Field(description="The JSON Schema definition, following Draft-07 specification, used to validate tax identifier data.", alias="schema") - __properties: ClassVar[List[str]] = ["countryCode", "schema"] + __properties: ClassVar[List[str]] = ["countryCode", "schemaType", "schema"] model_config = ConfigDict( populate_by_name=True, @@ -98,6 +99,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "countryCode": obj.get("countryCode"), + "schemaType": obj.get("schemaType"), "schema": obj.get("schema") }) return _obj diff --git a/Avalara/SDK/models/EInvoicing/V1/trading_partner.py b/Avalara/SDK/models/EInvoicing/V1/trading_partner.py index cfdbd97..81e3c91 100644 --- a/Avalara/SDK/models/EInvoicing/V1/trading_partner.py +++ b/Avalara/SDK/models/EInvoicing/V1/trading_partner.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py b/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py index ba379bf..6bd2c64 100644 --- a/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/update_trading_partner200_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/validation_error.py b/Avalara/SDK/models/EInvoicing/V1/validation_error.py index 8b9996e..3c43e5c 100644 --- a/Avalara/SDK/models/EInvoicing/V1/validation_error.py +++ b/Avalara/SDK/models/EInvoicing/V1/validation_error.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py b/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py index 993f16a..591ae68 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhook_invocation.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py index cc90202..7109712 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_info.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py index a441cdf..bf434b5 100644 --- a/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py +++ b/Avalara/SDK/models/EInvoicing/V1/webhooks_error_response.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py b/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py index 2274ce6..e055da5 100644 --- a/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py +++ b/Avalara/SDK/models/EInvoicing/V1/workflow_ids.py @@ -24,7 +24,7 @@ @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ diff --git a/README.md b/README.md index 0ae20b0..6b57a7d 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,8 @@ with ApiClient(configuration) as api_client: Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- +*CodeListsApi* | [**get_code_list**](docs/EInvoicing/V1/CodeListsApi.md#get_code_list) | **GET** /codelists/{codelistId} | Retrieves a code list by ID for a specific country +*CodeListsApi* | [**get_code_list_list**](docs/EInvoicing/V1/CodeListsApi.md#get_code_list_list) | **GET** /codelists | Returns a list of code lists for a specific country *DataInputFieldsApi* | [**get_data_input_fields**](docs/EInvoicing/V1/DataInputFieldsApi.md#get_data_input_fields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates *DocumentsApi* | [**download_document**](docs/EInvoicing/V1/DocumentsApi.md#download_document) | **GET** /documents/{documentId}/$download | Returns a copy of the document *DocumentsApi* | [**fetch_documents**](docs/EInvoicing/V1/DocumentsApi.md#fetch_documents) | **POST** /documents/$fetch | Fetch the inbound document from a tax authority @@ -155,11 +157,14 @@ Class | Method | HTTP request | Description *InteropApi* | [**submit_interop_document**](docs/EInvoicing/V1/InteropApi.md#submit_interop_document) | **POST** /interop/documents | Submit a document *MandatesApi* | [**get_mandate_data_input_fields**](docs/EInvoicing/V1/MandatesApi.md#get_mandate_data_input_fields) | **GET** /mandates/{mandateId}/data-input-fields | Returns document field information for a country mandate, a selected document type, and its version *MandatesApi* | [**get_mandates**](docs/EInvoicing/V1/MandatesApi.md#get_mandates) | **GET** /mandates | List country mandates that are supported by the Avalara E-Invoicing platform +*ReportsApi* | [**download_report**](docs/EInvoicing/V1/ReportsApi.md#download_report) | **GET** /reports/{reportId}/$download | Returns a pre-signed download URL for a report +*ReportsApi* | [**get_report_by_id**](docs/EInvoicing/V1/ReportsApi.md#get_report_by_id) | **GET** /reports/{reportId}/status | Retrieves a report by its unique ID +*ReportsApi* | [**get_reports**](docs/EInvoicing/V1/ReportsApi.md#get_reports) | **GET** /reports | Returns a list of reports *SubscriptionsApi* | [**create_webhook_subscription**](docs/EInvoicing/V1/SubscriptionsApi.md#create_webhook_subscription) | **POST** /webhooks/subscriptions | Create a subscription to events -*SubscriptionsApi* | [**delete_webhook_subscription**](docs/EInvoicing/V1/SubscriptionsApi.md#delete_webhook_subscription) | **DELETE** /webhooks/subscriptions/{subscription-id} | Unsubscribe from events -*SubscriptionsApi* | [**get_webhook_subscription**](docs/EInvoicing/V1/SubscriptionsApi.md#get_webhook_subscription) | **GET** /webhooks/subscriptions/{subscription-id} | Get details of a subscription +*SubscriptionsApi* | [**delete_webhook_subscription**](docs/EInvoicing/V1/SubscriptionsApi.md#delete_webhook_subscription) | **DELETE** /webhooks/subscriptions/{subscriptionId} | Unsubscribe from events +*SubscriptionsApi* | [**get_webhook_subscription**](docs/EInvoicing/V1/SubscriptionsApi.md#get_webhook_subscription) | **GET** /webhooks/subscriptions/{subscriptionId} | Get details of a subscription *SubscriptionsApi* | [**list_webhook_subscriptions**](docs/EInvoicing/V1/SubscriptionsApi.md#list_webhook_subscriptions) | **GET** /webhooks/subscriptions | List all subscriptions -*TaxIdentifiersApi* | [**tax_identifier_schema_by_country**](docs/EInvoicing/V1/TaxIdentifiersApi.md#tax_identifier_schema_by_country) | **GET** /tax-identifiers/schema | Returns the tax identifier request & response schema for a specific country. +*TaxIdentifiersApi* | [**tax_identifier_schema_by_country**](docs/EInvoicing/V1/TaxIdentifiersApi.md#tax_identifier_schema_by_country) | **GET** /tax-identifiers/schema | Returns the tax identifier request and response schema for a specific country. *TaxIdentifiersApi* | [**validate_tax_identifier**](docs/EInvoicing/V1/TaxIdentifiersApi.md#validate_tax_identifier) | **POST** /tax-identifiers/validate | Validates a tax identifier. *TradingPartnersApi* | [**batch_search_participants**](docs/EInvoicing/V1/TradingPartnersApi.md#batch_search_participants) | **POST** /trading-partners/batch-searches | Handles batch search requests by uploading a file containing search parameters. *TradingPartnersApi* | [**create_trading_partner**](docs/EInvoicing/V1/TradingPartnersApi.md#create_trading_partner) | **POST** /trading-partners | Creates a new trading partner. @@ -171,39 +176,6 @@ Class | Method | HTTP request | Description *TradingPartnersApi* | [**search_participants**](docs/EInvoicing/V1/TradingPartnersApi.md#search_participants) | **GET** /trading-partners | Returns a list of participants matching the input query. *TradingPartnersApi* | [**update_trading_partner**](docs/EInvoicing/V1/TradingPartnersApi.md#update_trading_partner) | **PUT** /trading-partners/{id} | Updates a trading partner using ID. - -### A1099 V2 API Documentation - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*CompaniesW9Api* | [**create_company**](docs/A1099/V2/CompaniesW9Api.md#create_company) | **POST** /w9/companies | Create a company -*CompaniesW9Api* | [**delete_company**](docs/A1099/V2/CompaniesW9Api.md#delete_company) | **DELETE** /w9/companies/{id} | Delete a company -*CompaniesW9Api* | [**get_companies**](docs/A1099/V2/CompaniesW9Api.md#get_companies) | **GET** /w9/companies | List companies -*CompaniesW9Api* | [**get_company**](docs/A1099/V2/CompaniesW9Api.md#get_company) | **GET** /w9/companies/{id} | Retrieve a company -*CompaniesW9Api* | [**update_company**](docs/A1099/V2/CompaniesW9Api.md#update_company) | **PUT** /w9/companies/{id} | Update a company -*Forms1099Api* | [**bulk_upsert1099_forms**](docs/A1099/V2/Forms1099Api.md#bulk_upsert1099_forms) | **POST** /1099/forms/$bulk-upsert | Create or update multiple 1099/1095/W2/1042S forms -*Forms1099Api* | [**create1099_form**](docs/A1099/V2/Forms1099Api.md#create1099_form) | **POST** /1099/forms | Create a 1099/1095/W2/1042S form -*Forms1099Api* | [**delete1099_form**](docs/A1099/V2/Forms1099Api.md#delete1099_form) | **DELETE** /1099/forms/{id} | Delete a 1099/1095/W2/1042S form -*Forms1099Api* | [**get1099_form**](docs/A1099/V2/Forms1099Api.md#get1099_form) | **GET** /1099/forms/{id} | Retrieve a 1099/1095/W2/1042S form -*Forms1099Api* | [**get1099_form_pdf**](docs/A1099/V2/Forms1099Api.md#get1099_form_pdf) | **GET** /1099/forms/{id}/pdf | Retrieve the PDF file for a 1099/1095/W2/1042S form -*Forms1099Api* | [**list1099_forms**](docs/A1099/V2/Forms1099Api.md#list1099_forms) | **GET** /1099/forms | List 1099/1095/W2/1042S forms -*Forms1099Api* | [**update1099_form**](docs/A1099/V2/Forms1099Api.md#update1099_form) | **PUT** /1099/forms/{id} | Update a 1099/1095/W2/1042S form -*FormsW9Api* | [**create_and_send_w9_form_email**](docs/A1099/V2/FormsW9Api.md#create_and_send_w9_form_email) | **POST** /w9/forms/$create-and-send-email | Create a minimal W9/W4/W8 form and sends the e-mail request -*FormsW9Api* | [**create_w9_form**](docs/A1099/V2/FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form -*FormsW9Api* | [**delete_w9_form**](docs/A1099/V2/FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form -*FormsW9Api* | [**get_w9_form**](docs/A1099/V2/FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form -*FormsW9Api* | [**get_w9_form_pdf**](docs/A1099/V2/FormsW9Api.md#get_w9_form_pdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form. -*FormsW9Api* | [**list_w9_forms**](docs/A1099/V2/FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms -*FormsW9Api* | [**send_w9_form_email**](docs/A1099/V2/FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form -*FormsW9Api* | [**update_w9_form**](docs/A1099/V2/FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form -*FormsW9Api* | [**upload_w9_files**](docs/A1099/V2/FormsW9Api.md#upload_w9_files) | **POST** /w9/forms/{id}/attachment | Replace the PDF file for a W9/W4/W8 form -*Issuers1099Api* | [**create_issuer**](docs/A1099/V2/Issuers1099Api.md#create_issuer) | **POST** /1099/issuers | Create an issuer -*Issuers1099Api* | [**delete_issuer**](docs/A1099/V2/Issuers1099Api.md#delete_issuer) | **DELETE** /1099/issuers/{id} | Delete an issuer -*Issuers1099Api* | [**get_issuer**](docs/A1099/V2/Issuers1099Api.md#get_issuer) | **GET** /1099/issuers/{id} | Retrieve an issuer -*Issuers1099Api* | [**get_issuers**](docs/A1099/V2/Issuers1099Api.md#get_issuers) | **GET** /1099/issuers | List issuers -*Issuers1099Api* | [**update_issuer**](docs/A1099/V2/Issuers1099Api.md#update_issuer) | **PUT** /1099/issuers/{id} | Update an issuer -*JobsApi* | [**get_job**](docs/A1099/V2/JobsApi.md#get_job) | **GET** /jobs/{id} | Retrieves information about the job - ## Documentation for Models @@ -217,6 +189,11 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.EInvoicing.V1.BatchSearch](docs/EInvoicing/V1/BatchSearch.md) - [Avalara.SDK.models.EInvoicing.V1.BatchSearchListResponse](docs/EInvoicing/V1/BatchSearchListResponse.md) - [Avalara.SDK.models.EInvoicing.V1.BatchSearchParticipants202Response](docs/EInvoicing/V1/BatchSearchParticipants202Response.md) + - [Avalara.SDK.models.EInvoicing.V1.CodeListListResponse](docs/EInvoicing/V1/CodeListListResponse.md) + - [Avalara.SDK.models.EInvoicing.V1.CodeListResponse](docs/EInvoicing/V1/CodeListResponse.md) + - [Avalara.SDK.models.EInvoicing.V1.CodeListSummary](docs/EInvoicing/V1/CodeListSummary.md) + - [Avalara.SDK.models.EInvoicing.V1.CodeListValue](docs/EInvoicing/V1/CodeListValue.md) + - [Avalara.SDK.models.EInvoicing.V1.CodeListVersion](docs/EInvoicing/V1/CodeListVersion.md) - [Avalara.SDK.models.EInvoicing.V1.ConditionalForField](docs/EInvoicing/V1/ConditionalForField.md) - [Avalara.SDK.models.EInvoicing.V1.Consents](docs/EInvoicing/V1/Consents.md) - [Avalara.SDK.models.EInvoicing.V1.CreateTradingPartner201Response](docs/EInvoicing/V1/CreateTradingPartner201Response.md) @@ -258,6 +235,9 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.EInvoicing.V1.NotUsedForField](docs/EInvoicing/V1/NotUsedForField.md) - [Avalara.SDK.models.EInvoicing.V1.OutputDataFormats](docs/EInvoicing/V1/OutputDataFormats.md) - [Avalara.SDK.models.EInvoicing.V1.Pagination](docs/EInvoicing/V1/Pagination.md) + - [Avalara.SDK.models.EInvoicing.V1.ReportDownloadResponse](docs/EInvoicing/V1/ReportDownloadResponse.md) + - [Avalara.SDK.models.EInvoicing.V1.ReportItem](docs/EInvoicing/V1/ReportItem.md) + - [Avalara.SDK.models.EInvoicing.V1.ReportListResponse](docs/EInvoicing/V1/ReportListResponse.md) - [Avalara.SDK.models.EInvoicing.V1.RequiredWhenField](docs/EInvoicing/V1/RequiredWhenField.md) - [Avalara.SDK.models.EInvoicing.V1.SearchParticipants200Response](docs/EInvoicing/V1/SearchParticipants200Response.md) - [Avalara.SDK.models.EInvoicing.V1.Signature](docs/EInvoicing/V1/Signature.md) @@ -272,6 +252,7 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.EInvoicing.V1.SubscriptionListResponse](docs/EInvoicing/V1/SubscriptionListResponse.md) - [Avalara.SDK.models.EInvoicing.V1.SubscriptionRegistration](docs/EInvoicing/V1/SubscriptionRegistration.md) - [Avalara.SDK.models.EInvoicing.V1.SuccessResponse](docs/EInvoicing/V1/SuccessResponse.md) + - [Avalara.SDK.models.EInvoicing.V1.SupportedDocumentStatuses](docs/EInvoicing/V1/SupportedDocumentStatuses.md) - [Avalara.SDK.models.EInvoicing.V1.SupportedDocumentTypes](docs/EInvoicing/V1/SupportedDocumentTypes.md) - [Avalara.SDK.models.EInvoicing.V1.TaxIdentifierRequest](docs/EInvoicing/V1/TaxIdentifierRequest.md) - [Avalara.SDK.models.EInvoicing.V1.TaxIdentifierResponse](docs/EInvoicing/V1/TaxIdentifierResponse.md) @@ -284,68 +265,3 @@ Class | Method | HTTP request | Description - [Avalara.SDK.models.EInvoicing.V1.WebhooksErrorInfo](docs/EInvoicing/V1/WebhooksErrorInfo.md) - [Avalara.SDK.models.EInvoicing.V1.WebhooksErrorResponse](docs/EInvoicing/V1/WebhooksErrorResponse.md) - [Avalara.SDK.models.EInvoicing.V1.WorkflowIds](docs/EInvoicing/V1/WorkflowIds.md) - - - -### A1099 V2 Model Documentation - - - [Avalara.SDK.models.A1099.V2.CompanyBase](docs/A1099/V2/CompanyBase.md) - - [Avalara.SDK.models.A1099.V2.CompanyRequest](docs/A1099/V2/CompanyRequest.md) - - [Avalara.SDK.models.A1099.V2.CompanyResponse](docs/A1099/V2/CompanyResponse.md) - - [Avalara.SDK.models.A1099.V2.CoveredIndividual](docs/A1099/V2/CoveredIndividual.md) - - [Avalara.SDK.models.A1099.V2.CreateAndSendW9FormEmailRequest](docs/A1099/V2/CreateAndSendW9FormEmailRequest.md) - - [Avalara.SDK.models.A1099.V2.CreateW9Form201Response](docs/A1099/V2/CreateW9Form201Response.md) - - [Avalara.SDK.models.A1099.V2.CreateW9FormRequest](docs/A1099/V2/CreateW9FormRequest.md) - - [Avalara.SDK.models.A1099.V2.EntryStatusResponse](docs/A1099/V2/EntryStatusResponse.md) - - [Avalara.SDK.models.A1099.V2.ErrorResponse](docs/A1099/V2/ErrorResponse.md) - - [Avalara.SDK.models.A1099.V2.ErrorResponseItem](docs/A1099/V2/ErrorResponseItem.md) - - [Avalara.SDK.models.A1099.V2.Form1042S](docs/A1099/V2/Form1042S.md) - - [Avalara.SDK.models.A1099.V2.Form1095B](docs/A1099/V2/Form1095B.md) - - [Avalara.SDK.models.A1099.V2.Form1095C](docs/A1099/V2/Form1095C.md) - - [Avalara.SDK.models.A1099.V2.Form1099Base](docs/A1099/V2/Form1099Base.md) - - [Avalara.SDK.models.A1099.V2.Form1099Div](docs/A1099/V2/Form1099Div.md) - - [Avalara.SDK.models.A1099.V2.Form1099Int](docs/A1099/V2/Form1099Int.md) - - [Avalara.SDK.models.A1099.V2.Form1099K](docs/A1099/V2/Form1099K.md) - - [Avalara.SDK.models.A1099.V2.Form1099ListRequest](docs/A1099/V2/Form1099ListRequest.md) - - [Avalara.SDK.models.A1099.V2.Form1099Misc](docs/A1099/V2/Form1099Misc.md) - - [Avalara.SDK.models.A1099.V2.Form1099Nec](docs/A1099/V2/Form1099Nec.md) - - [Avalara.SDK.models.A1099.V2.Form1099R](docs/A1099/V2/Form1099R.md) - - [Avalara.SDK.models.A1099.V2.Form1099StatusDetail](docs/A1099/V2/Form1099StatusDetail.md) - - [Avalara.SDK.models.A1099.V2.Get1099Form200Response](docs/A1099/V2/Get1099Form200Response.md) - - [Avalara.SDK.models.A1099.V2.IntermediaryOrFlowThrough](docs/A1099/V2/IntermediaryOrFlowThrough.md) - - [Avalara.SDK.models.A1099.V2.IrsResponse](docs/A1099/V2/IrsResponse.md) - - [Avalara.SDK.models.A1099.V2.IssuerBase](docs/A1099/V2/IssuerBase.md) - - [Avalara.SDK.models.A1099.V2.IssuerRequest](docs/A1099/V2/IssuerRequest.md) - - [Avalara.SDK.models.A1099.V2.IssuerResponse](docs/A1099/V2/IssuerResponse.md) - - [Avalara.SDK.models.A1099.V2.JobResponse](docs/A1099/V2/JobResponse.md) - - [Avalara.SDK.models.A1099.V2.OfferAndCoverage](docs/A1099/V2/OfferAndCoverage.md) - - [Avalara.SDK.models.A1099.V2.PaginatedQueryResultModelCompanyResponse](docs/A1099/V2/PaginatedQueryResultModelCompanyResponse.md) - - [Avalara.SDK.models.A1099.V2.PaginatedQueryResultModelForm1099Base](docs/A1099/V2/PaginatedQueryResultModelForm1099Base.md) - - [Avalara.SDK.models.A1099.V2.PaginatedQueryResultModelIssuerResponse](docs/A1099/V2/PaginatedQueryResultModelIssuerResponse.md) - - [Avalara.SDK.models.A1099.V2.PaginatedQueryResultModelW9FormBaseResponse](docs/A1099/V2/PaginatedQueryResultModelW9FormBaseResponse.md) - - [Avalara.SDK.models.A1099.V2.PrimaryWithholdingAgent](docs/A1099/V2/PrimaryWithholdingAgent.md) - - [Avalara.SDK.models.A1099.V2.StateAndLocalWithholding](docs/A1099/V2/StateAndLocalWithholding.md) - - [Avalara.SDK.models.A1099.V2.StateEfileStatusDetail](docs/A1099/V2/StateEfileStatusDetail.md) - - [Avalara.SDK.models.A1099.V2.SubstantialUsOwnerRequest](docs/A1099/V2/SubstantialUsOwnerRequest.md) - - [Avalara.SDK.models.A1099.V2.SubstantialUsOwnerResponse](docs/A1099/V2/SubstantialUsOwnerResponse.md) - - [Avalara.SDK.models.A1099.V2.TinMatchStatusResponse](docs/A1099/V2/TinMatchStatusResponse.md) - - [Avalara.SDK.models.A1099.V2.ValidationError](docs/A1099/V2/ValidationError.md) - - [Avalara.SDK.models.A1099.V2.W4FormMinimalRequest](docs/A1099/V2/W4FormMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W4FormRequest](docs/A1099/V2/W4FormRequest.md) - - [Avalara.SDK.models.A1099.V2.W4FormResponse](docs/A1099/V2/W4FormResponse.md) - - [Avalara.SDK.models.A1099.V2.W8BenEFormMinimalRequest](docs/A1099/V2/W8BenEFormMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W8BenEFormRequest](docs/A1099/V2/W8BenEFormRequest.md) - - [Avalara.SDK.models.A1099.V2.W8BenEFormResponse](docs/A1099/V2/W8BenEFormResponse.md) - - [Avalara.SDK.models.A1099.V2.W8BenFormMinimalRequest](docs/A1099/V2/W8BenFormMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W8BenFormRequest](docs/A1099/V2/W8BenFormRequest.md) - - [Avalara.SDK.models.A1099.V2.W8BenFormResponse](docs/A1099/V2/W8BenFormResponse.md) - - [Avalara.SDK.models.A1099.V2.W8ImyFormMinimalRequest](docs/A1099/V2/W8ImyFormMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W8ImyFormRequest](docs/A1099/V2/W8ImyFormRequest.md) - - [Avalara.SDK.models.A1099.V2.W8ImyFormResponse](docs/A1099/V2/W8ImyFormResponse.md) - - [Avalara.SDK.models.A1099.V2.W9FormBaseMinimalRequest](docs/A1099/V2/W9FormBaseMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W9FormBaseRequest](docs/A1099/V2/W9FormBaseRequest.md) - - [Avalara.SDK.models.A1099.V2.W9FormBaseResponse](docs/A1099/V2/W9FormBaseResponse.md) - - [Avalara.SDK.models.A1099.V2.W9FormMinimalRequest](docs/A1099/V2/W9FormMinimalRequest.md) - - [Avalara.SDK.models.A1099.V2.W9FormRequest](docs/A1099/V2/W9FormRequest.md) - - [Avalara.SDK.models.A1099.V2.W9FormResponse](docs/A1099/V2/W9FormResponse.md) - diff --git a/docs/EInvoicing/V1/CodeListListResponse.md b/docs/EInvoicing/V1/CodeListListResponse.md new file mode 100644 index 0000000..2db70df --- /dev/null +++ b/docs/EInvoicing/V1/CodeListListResponse.md @@ -0,0 +1,32 @@ +# CodeListListResponse + +Returns the requested list of code lists + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recordset_count** | **str** | Count of code lists for the given query parameters | [optional] +**next_link** | **str** | | [optional] +**value** | [**List[CodeListSummary]**](CodeListSummary.md) | Array of code lists matching query parameters | + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.code_list_list_response import CodeListListResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CodeListListResponse from a JSON string +code_list_list_response_instance = CodeListListResponse.from_json(json) +# print the JSON string representation of the object +print(CodeListListResponse.to_json()) + +# convert the object into a dict +code_list_list_response_dict = code_list_list_response_instance.to_dict() +# create an instance of CodeListListResponse from a dict +code_list_list_response_from_dict = CodeListListResponse.from_dict(code_list_list_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/CodeListResponse.md b/docs/EInvoicing/V1/CodeListResponse.md new file mode 100644 index 0000000..407e877 --- /dev/null +++ b/docs/EInvoicing/V1/CodeListResponse.md @@ -0,0 +1,35 @@ +# CodeListResponse + +Returns a code list definition for a specific country + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country_code** | **str** | Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to. | [optional] +**code_list_id** | **str** | System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs. | [optional] +**code_list_name** | **str** | Human-readable name of the code list, usually describing what the codes represent (for example, document types, tax categories, currencies). | [optional] +**description** | **str** | Textual description of the code list, including what it is used for and whether it represents a global standard (e.g., UN/CEFACT, ISO, EN16931) or a jurisdiction-specific/local extension of that standard. | [optional] +**standard** | **str** | Identifier of the underlying standard or authoritative source for this code list. This may be a formal code list name (e.g., UNCL1001), a standard reference (e.g., EN16931), or an internal standard identifier. | [optional] +**versions** | [**List[CodeListVersion]**](CodeListVersion.md) | Array of versioned definitions of this code list for the given jurisdiction. Each entry represents a version that is valid for a specific effective/sunset date range, optionally per locale. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.code_list_response import CodeListResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CodeListResponse from a JSON string +code_list_response_instance = CodeListResponse.from_json(json) +# print the JSON string representation of the object +print(CodeListResponse.to_json()) + +# convert the object into a dict +code_list_response_dict = code_list_response_instance.to_dict() +# create an instance of CodeListResponse from a dict +code_list_response_from_dict = CodeListResponse.from_dict(code_list_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/CodeListSummary.md b/docs/EInvoicing/V1/CodeListSummary.md new file mode 100644 index 0000000..990b40a --- /dev/null +++ b/docs/EInvoicing/V1/CodeListSummary.md @@ -0,0 +1,35 @@ +# CodeListSummary + +Displays a summary of information about a code list + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country_code** | **str** | Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to. | [optional] +**code_list_id** | **str** | System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs. | [optional] +**code_list_name** | **str** | Human-readable name of the code list, usually describing what the codes represent (for example, document types, tax categories, currencies). | [optional] +**description** | **str** | Textual description of the code list, including what it is used for and whether it represents a global standard (e.g., UN/CEFACT, ISO, EN16931) or a jurisdiction-specific/local extension of that standard. | [optional] +**standard** | **str** | Identifier of the underlying standard or authoritative source for this code list. This may be a formal code list name (e.g., UNCL1001), a standard reference (e.g., EN16931), or an internal standard identifier. | [optional] +**versions** | [**List[CodeListVersion]**](CodeListVersion.md) | Array of versioned definitions of this code list for the given jurisdiction. Each entry represents a version that is valid for a specific effective/sunset date range, optionally per locale. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.code_list_summary import CodeListSummary + +# TODO update the JSON string below +json = "{}" +# create an instance of CodeListSummary from a JSON string +code_list_summary_instance = CodeListSummary.from_json(json) +# print the JSON string representation of the object +print(CodeListSummary.to_json()) + +# convert the object into a dict +code_list_summary_dict = code_list_summary_instance.to_dict() +# create an instance of CodeListSummary from a dict +code_list_summary_from_dict = CodeListSummary.from_dict(code_list_summary_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/CodeListValue.md b/docs/EInvoicing/V1/CodeListValue.md new file mode 100644 index 0000000..d9e6d66 --- /dev/null +++ b/docs/EInvoicing/V1/CodeListValue.md @@ -0,0 +1,32 @@ +# CodeListValue + +Represents a single code entry in a code list version + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | The actual code value used in documents or systems. This is typically what appears in the e-invoice payload, such as a numeric or alphanumeric code from the official code list. | [optional] +**value** | **str** | Human-readable label or name for the code, localized according to the locale field of the version. | [optional] +**description** | **str** | Detailed explanation of what the code represents, localized according to the locale field of the version. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.code_list_value import CodeListValue + +# TODO update the JSON string below +json = "{}" +# create an instance of CodeListValue from a JSON string +code_list_value_instance = CodeListValue.from_json(json) +# print the JSON string representation of the object +print(CodeListValue.to_json()) + +# convert the object into a dict +code_list_value_dict = code_list_value_instance.to_dict() +# create an instance of CodeListValue from a dict +code_list_value_from_dict = CodeListValue.from_dict(code_list_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/CodeListVersion.md b/docs/EInvoicing/V1/CodeListVersion.md new file mode 100644 index 0000000..ab39470 --- /dev/null +++ b/docs/EInvoicing/V1/CodeListVersion.md @@ -0,0 +1,34 @@ +# CodeListVersion + +Represents a versioned definition of a code list for a specific jurisdiction and date range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version_reasons** | **List[str]** | List of free-text reasons explaining why this version of the code list exists (for example, initial introduction, regulatory update, addition/deprecation of codes). Useful for audit and change tracking. | [optional] +**juris_effective_date** | **date** | Date from which this version of the code list becomes legally or operationally effective in the jurisdiction. Typically corresponds to a go-live, mandate, or release date. | [optional] +**juris_sunset_date** | **date** | Date after which this version of the code list must no longer be used in the jurisdiction. Use a far-future date (e.g., 9999-12-31) when the sunset is not yet known. | [optional] +**locale** | **str** | Language–region locale identifier indicating the language and regional variant for descriptions in this version of the code list. Follows BCP-47 format such as en-US, fr-FR, de-DE. | [optional] +**values** | [**List[CodeListValue]**](CodeListValue.md) | Array of code entries defined in this version of the code list. Each entry contains the machine-readable code value and its human-readable description in the given locale. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.code_list_version import CodeListVersion + +# TODO update the JSON string below +json = "{}" +# create an instance of CodeListVersion from a JSON string +code_list_version_instance = CodeListVersion.from_json(json) +# print the JSON string representation of the object +print(CodeListVersion.to_json()) + +# convert the object into a dict +code_list_version_dict = code_list_version_instance.to_dict() +# create an instance of CodeListVersion from a dict +code_list_version_from_dict = CodeListVersion.from_dict(code_list_version_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/CodeListsApi.md b/docs/EInvoicing/V1/CodeListsApi.md new file mode 100644 index 0000000..ba88d84 --- /dev/null +++ b/docs/EInvoicing/V1/CodeListsApi.md @@ -0,0 +1,204 @@ +# Avalara.SDK.CodeListsApi + +All URIs are relative to *https://api.sbx.avalara.com/einvoicing* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_code_list**](CodeListsApi.md#get_code_list) | **GET** /codelists/{codelistId} | Retrieves a code list by ID for a specific country +[**get_code_list_list**](CodeListsApi.md#get_code_list_list) | **GET** /codelists | Returns a list of code lists for a specific country + + +# **get_code_list** +> CodeListResponse get_code_list(avalara_version, codelist_id, country_code) + +Retrieves a code list by ID for a specific country + +A Code List is a controlled set of predefined, standardized values used to populate specific fields in electronic documents (such as e-invoices). Each code has a stable, machine-readable identifier and a human-readable description. Code Lists are typically based on global standards (e.g., UN/CEFACT, ISO, EN16931) and may include jurisdiction-specific extensions or restrictions.

Code Lists are versioned, and each version may have defined effective and sunset dates to ensure that the correct set of allowable values is applied according to regulatory or jurisdictional requirements.

By default, the API returns only non-expired code list versions (versions where the sunset date has not passed). To retrieve expired versions or filter by specific date ranges, use the effectiveDate and sunsetDate query parameters. + +### Example + +* Bearer (JWT) Authentication (Bearer): + +```python +import time +import Avalara.SDK +from Avalara.SDK.api.EInvoicing.V1 import code_lists_api +BadRequest +ForbiddenError +NotFoundError +CodeListResponse +from pprint import pprint + +# Define configuration object with parameters specified to your application. +configuration = Avalara.SDK.Configuration( + app_name='test app' + app_version='1.0' + machine_name='some machine' + client_id='' + client_secret='' + environment='sandbox' +) +# Enter a context with an instance of the API client +with Avalara.SDK.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = code_lists_api.CodeListsApi(api_client) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + codelist_id = 'ab123343-3432-423c-ac3f-53453scs9999' # str | System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs. + country_code = 'FR' # str | Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + effective_date = 'Tue Dec 31 16:00:00 PST 2024' # date | Filter code list versions by effective date. Returns versions that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided. (optional) + sunset_date = 'Wed Dec 30 16:00:00 PST 2026' # date | Filter code list versions by sunset date. Returns versions that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired versions are returned. (optional) + # example passing only required values which don't have defaults set + try: + # Retrieves a code list by ID for a specific country + api_response = api_instance.get_code_list(avalara_version, codelist_id, country_code) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling CodeListsApi->get_code_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Retrieves a code list by ID for a specific country + api_response = api_instance.get_code_list(avalara_version, codelist_id, country_code, x_avalara_client=x_avalara_client, effective_date=effective_date, sunset_date=sunset_date) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling CodeListsApi->get_code_list: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **codelist_id** | **str**| System-generated unique identifier of the code list definition. Typically a UUID used to reference this code list internally or via APIs. | + **country_code** | **str**| Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction this code list applies to. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **effective_date** | **date**| Filter code list versions by effective date. Returns versions that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided. | [optional] + **sunset_date** | **date**| Filter code list versions by sunset date. Returns versions that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired versions are returned. | [optional] + +### Return type + +[**CodeListResponse**](CodeListResponse.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | +**404** | Code list not found. | - | + +[[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_code_list_list** +> CodeListListResponse get_code_list_list(avalara_version, country_code) + +Returns a list of code lists for a specific country + +Get a list of code lists on the Avalara E-Invoicing platform for the specified country. By default, the API returns only non-expired code lists (code lists where the sunset date has not passed). To retrieve expired code lists or filter by specific date ranges, use the effectiveDate and sunsetDate query parameters.

A Code List is a controlled set of predefined, standardized values used to populate specific fields in electronic documents (such as e-invoices). Each code has a stable, machine-readable identifier and a human-readable description. Code Lists are typically based on global standards (e.g., UN/CEFACT, ISO, EN16931) and may include jurisdiction-specific extensions or restrictions. + +### Example + +* Bearer (JWT) Authentication (Bearer): + +```python +import time +import Avalara.SDK +from Avalara.SDK.api.EInvoicing.V1 import code_lists_api +BadRequest +ForbiddenError +CodeListListResponse +from pprint import pprint + +# Define configuration object with parameters specified to your application. +configuration = Avalara.SDK.Configuration( + app_name='test app' + app_version='1.0' + machine_name='some machine' + client_id='' + client_secret='' + environment='sandbox' +) +# Enter a context with an instance of the API client +with Avalara.SDK.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = code_lists_api.CodeListsApi(api_client) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + country_code = 'FR' # str | Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction for which code lists should be returned. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + effective_date = 'Tue Dec 31 16:00:00 PST 2024' # date | Filter code lists by effective date. Returns code lists that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided. (optional) + sunset_date = 'Wed Dec 30 16:00:00 PST 2026' # date | Filter code lists by sunset date. Returns code lists that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired code lists are returned. (optional) + count = 'true' # str | When set to true, the response body also includes the count of items in the collection. (optional) + count_only = 'false' # str | When set to true, the response returns only the count of items in the collection. (optional) + top = 56 # int | The number of items to include in the result. (optional) + skip = 56 # int | The number of items to skip in the result. (optional) + # example passing only required values which don't have defaults set + try: + # Returns a list of code lists for a specific country + api_response = api_instance.get_code_list_list(avalara_version, country_code) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling CodeListsApi->get_code_list_list: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Returns a list of code lists for a specific country + api_response = api_instance.get_code_list_list(avalara_version, country_code, x_avalara_client=x_avalara_client, effective_date=effective_date, sunset_date=sunset_date, count=count, count_only=count_only, top=top, skip=skip) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling CodeListsApi->get_code_list_list: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **country_code** | **str**| Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction for which code lists should be returned. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **effective_date** | **date**| Filter code lists by effective date. Returns code lists that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided. | [optional] + **sunset_date** | **date**| Filter code lists by sunset date. Returns code lists that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired code lists are returned. | [optional] + **count** | **str**| When set to true, the response body also includes the count of items in the collection. | [optional] + **count_only** | **str**| When set to true, the response returns only the count of items in the collection. | [optional] + **top** | **int**| The number of items to include in the result. | [optional] + **skip** | **int**| The number of items to skip in the result. | [optional] + +### Return type + +[**CodeListListResponse**](CodeListListResponse.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | + +[[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/EInvoicing/V1/DataInputFieldsApi.md b/docs/EInvoicing/V1/DataInputFieldsApi.md index 221bffe..ba836dc 100644 --- a/docs/EInvoicing/V1/DataInputFieldsApi.md +++ b/docs/EInvoicing/V1/DataInputFieldsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Returns the optionality of document fields for different country mandates -This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the mandates endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate +This endpoint returns a list of required, conditional, and optional fields for each country mandate. Use the mandates endpoint to retrieve all available country mandates. Use the $filter query parameter to retrieve fields for a specific mandate. ### Example @@ -40,13 +40,13 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = data_input_fields_api.DataInputFieldsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) - filter = 'requiredFor/countryMandate eq AU-B2G-PEPPOL' # str | Filter by field name and value. This filter only supports eq and contains. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + filter = 'requiredFor/countryMandate eq AU-B2G-PEPPOL' # str | Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide. (optional) top = 56 # int | The number of items to include in the result. (optional) skip = 56 # int | The number of items to skip in the result. (optional) - count = true # bool | When set to true, the count of the collection is also returned in the response body (optional) - count_only = true # bool | When set to true, only the count of the collection is returned (optional) + count = true # bool | When set to true, the response body also includes the count of items in the collection. (optional) + count_only = true # bool | When set to true, the response returns only the count of items in the collection. (optional) # example passing only required values which don't have defaults set try: # Returns the optionality of document fields for different country mandates @@ -69,13 +69,13 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] - **filter** | **str**| Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **filter** | **str**| Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide. | [optional] **top** | **int**| The number of items to include in the result. | [optional] **skip** | **int**| The number of items to skip in the result. | [optional] - **count** | **bool**| When set to true, the count of the collection is also returned in the response body | [optional] - **count_only** | **bool**| When set to true, only the count of the collection is returned | [optional] + **count** | **bool**| When set to true, the response body also includes the count of items in the collection. | [optional] + **count_only** | **bool**| When set to true, the response returns only the count of items in the collection. | [optional] ### Return type @@ -95,10 +95,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**500** | Internal Server Error | - | +**200** | Returns a DataInputFieldsResponse object containing the data input fields and their optionality for the requested mandate. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | +**500** | Internal server error. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/DocumentStatusResponse.md b/docs/EInvoicing/V1/DocumentStatusResponse.md index e6cb485..2be007b 100644 --- a/docs/EInvoicing/V1/DocumentStatusResponse.md +++ b/docs/EInvoicing/V1/DocumentStatusResponse.md @@ -7,7 +7,8 @@ Returns the current document ID and status Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The unique ID for this document | [optional] -**status** | **str** | Status of the document | [optional] +**status** | **str** | Document status. See the `supportedDocumentStatuses` field in the GET /mandates response for full status definitions. | [optional] +**business_status** | **str** | Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation. | [optional] **events** | [**List[StatusEvent]**](StatusEvent.md) | | [optional] ## Example diff --git a/docs/EInvoicing/V1/DocumentSummary.md b/docs/EInvoicing/V1/DocumentSummary.md index 40349b5..90af445 100644 --- a/docs/EInvoicing/V1/DocumentSummary.md +++ b/docs/EInvoicing/V1/DocumentSummary.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **company_id** | **str** | Unique identifier that represents the company within the system. | [optional] **process_date_time** | **str** | The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] **status** | **str** | The Document status | [optional] +**business_status** | **str** | Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation. | [optional] **supplier_name** | **str** | The name of the supplier in the transaction | [optional] **customer_name** | **str** | The name of the customer in the transaction | [optional] **document_type** | **str** | The document type | [optional] @@ -21,6 +22,9 @@ Name | Type | Description | Notes **country_mandate** | **str** | The e-invoicing mandate for the specified country | [optional] **interface** | **str** | The interface where the document is sent | [optional] **receiver** | **str** | The document recipient based on the interface | [optional] +**events** | [**List[StatusEvent]**](StatusEvent.md) | Array of status events associated with this document. Events are included in each document in the response only when the query parameter $include=events is passed; otherwise the events array is not populated. | [optional] +**created_at** | **str** | The date and time when the document was created in the system, displayed in ISO 8601 format with timezone | [optional] +**last_updated_at** | **str** | The date and time when the document was last updated in the system, displayed in ISO 8601 format with timezone | [optional] ## Example diff --git a/docs/EInvoicing/V1/DocumentsApi.md b/docs/EInvoicing/V1/DocumentsApi.md index 83cc7bb..a909415 100644 --- a/docs/EInvoicing/V1/DocumentsApi.md +++ b/docs/EInvoicing/V1/DocumentsApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description Returns a copy of the document -When the document is available, use this endpoint to download it as text, XML, or PDF. The output format needs to be specified in the Accept header, and it will vary depending on the mandate. If the file has not yet been created, then status code 404 (not found) is returned. +Downloads the document when it is available. Specify the output format in the Accept header. Returns 404 if the file has not been created. ### Example @@ -44,10 +44,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = documents_api.DocumentsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - accept = 'application/pdf' # str | This header indicates the MIME type of the document - document_id = 'document_id_example' # str | The unique ID for this document that was returned in the POST /einvoicing/document response body - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + accept = 'application/pdf' # str | Header that specifies the MIME type of the returned document. + document_id = 'document_id_example' # str | The unique documentId returned in the POST /documents response body. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) # example passing only required values which don't have defaults set try: # Returns a copy of the document @@ -70,10 +70,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **accept** | **str**| This header indicates the MIME type of the document | - **document_id** | **str**| The unique ID for this document that was returned in the POST /einvoicing/document response body | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **accept** | **str**| Header that specifies the MIME type of the returned document. | + **document_id** | **str**| The unique documentId returned in the POST /documents response body. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] ### Return type @@ -93,11 +93,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | * Content-type -
| -**401** | Unauthorized | - | -**403** | Forbidden | - | +**200** | Returns the document content in the format specified by the Accept header. | * Content-type -
| +**401** | Unauthorized. | - | +**403** | Forbidden. | - | **404** | A document for the specified ID was not found. | - | -**406** | Unsupported document format was requested in the Accept header | - | +**406** | Unsupported document format was requested in the Accept header. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -106,7 +106,7 @@ Name | Type | Description | Notes Fetch the inbound document from a tax authority -This API allows you to retrieve an inbound document. Pass key-value pairs as parameters in the request, such as the confirmation number, supplier number, and buyer VAT number. +Retrieves an inbound document. Provide key-value pairs as request parameters. Supported parameters vary by tax authority and country. ### Example @@ -135,9 +135,9 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = documents_api.DocumentsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). fetch_documents_request = Avalara.SDK.FetchDocumentsRequest() # FetchDocumentsRequest | - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) # example passing only required values which don't have defaults set try: # Fetch the inbound document from a tax authority @@ -160,9 +160,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | **fetch_documents_request** | [**FetchDocumentsRequest**](FetchDocumentsRequest.md)| | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] ### Return type @@ -182,10 +182,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Accepted DocumentFetch Request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**500** | Internal Server Error | - | +**200** | Response from the inbound document fetch endpoint. Contains the platform documentId for status checks and downloads, the returned status (e.g. Accepted), and eventDateTime when the document was accepted. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | +**500** | Internal server error. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -194,7 +194,7 @@ Name | Type | Description | Notes Returns a summary of documents for a date range -Get a list of documents on the Avalara E-Invoicing platform that have a processing date within the specified date range. +Returns a list of document summaries with a processing date within the specified date range. ### Example @@ -222,14 +222,15 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = documents_api.DocumentsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) - start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date of documents to return. This defaults to the previous month. (optional) - end_date = '2013-10-20T19:20:30+01:00' # datetime | End date of documents to return. This defaults to the current date. (optional) - flow = 'out' # str | Optionally filter by document direction, where issued = `out` and received = `in` (optional) - count = 'true' # str | When set to true, the count of the collection is also returned in the response body (optional) - count_only = 'false' # str | When set to true, only the count of the collection is returned (optional) - filter = 'id eq 52f60401-44d0-4667-ad47-4afe519abb53' # str | Filter by field name and value. This filter only supports eq . Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided startDate and endDate. If no startDate or endDate is provided, defaults will be assumed. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + start_date = '2013-10-20T19:20:30+01:00' # datetime | Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\". (optional) + end_date = '2013-10-20T19:20:30+01:00' # datetime | End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\". (optional) + flow = 'out' # str | Optional filter for document direction: issued uses \"out\" and received uses \"in\". (optional) + count = 'true' # str | When set to true, the response body also includes the count of items in the collection. (optional) + count_only = 'false' # str | When set to true, the response returns only the count of items in the collection. (optional) + filter = 'id eq 52f60401-44d0-4667-ad47-4afe519abb53' # str | Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide. (optional) + include = 'events' # str | When set to `events`, each document in the response includes its events array. Omit this parameter or use any other value to exclude events from the response. (optional) top = 56 # int | The number of items to include in the result. (optional) skip = 56 # int | The number of items to skip in the result. (optional) # example passing only required values which don't have defaults set @@ -244,7 +245,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # and optional values try: # Returns a summary of documents for a date range - api_response = api_instance.get_document_list(avalara_version, x_avalara_client=x_avalara_client, start_date=start_date, end_date=end_date, flow=flow, count=count, count_only=count_only, filter=filter, top=top, skip=skip) + api_response = api_instance.get_document_list(avalara_version, x_avalara_client=x_avalara_client, start_date=start_date, end_date=end_date, flow=flow, count=count, count_only=count_only, filter=filter, include=include, top=top, skip=skip) pprint(api_response) except Avalara.SDK.ApiException as e: print("Exception when calling DocumentsApi->get_document_list: %s\n" % e) @@ -254,14 +255,15 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] - **start_date** | **datetime**| Start date of documents to return. This defaults to the previous month. | [optional] - **end_date** | **datetime**| End date of documents to return. This defaults to the current date. | [optional] - **flow** | **str**| Optionally filter by document direction, where issued = `out` and received = `in` | [optional] - **count** | **str**| When set to true, the count of the collection is also returned in the response body | [optional] - **count_only** | **str**| When set to true, only the count of the collection is returned | [optional] - **filter** | **str**| Filter by field name and value. This filter only supports <code>eq</code> . Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided startDate and endDate. If no startDate or endDate is provided, defaults will be assumed. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **start_date** | **datetime**| Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\". | [optional] + **end_date** | **datetime**| End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\". | [optional] + **flow** | **str**| Optional filter for document direction: issued uses \"out\" and received uses \"in\". | [optional] + **count** | **str**| When set to true, the response body also includes the count of items in the collection. | [optional] + **count_only** | **str**| When set to true, the response returns only the count of items in the collection. | [optional] + **filter** | **str**| Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide. | [optional] + **include** | **str**| When set to `events`, each document in the response includes its events array. Omit this parameter or use any other value to exclude events from the response. | [optional] **top** | **int**| The number of items to include in the result. | [optional] **skip** | **int**| The number of items to skip in the result. | [optional] @@ -283,10 +285,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | +**200** | Returns a collection of document summaries for the specified date range. | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -295,7 +297,7 @@ Name | Type | Description | Notes Checks the status of a document -Using the unique ID from POST /einvoicing/documents response body, request the current status of a document. +Uses the documentId from the POST /documents response body to return the current status of a document. ### Example @@ -323,9 +325,9 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = documents_api.DocumentsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - document_id = 'document_id_example' # str | The unique ID for this document that was returned in the POST /einvoicing/documents response body - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + document_id = 'document_id_example' # str | The unique documentId returned in the POST /documents response body. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) # example passing only required values which don't have defaults set try: # Checks the status of a document @@ -348,9 +350,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **document_id** | **str**| The unique ID for this document that was returned in the POST /einvoicing/documents response body | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **document_id** | **str**| The unique documentId returned in the POST /documents response body. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] ### Return type @@ -370,9 +372,9 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | +**200** | Returns the current status for the specified documentId. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | **404** | A document for the specified ID was not found. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -411,10 +413,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = documents_api.DocumentsApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). metadata = Avalara.SDK.SubmitDocumentMetadata() # SubmitDocumentMetadata | data = None # object | The document to be submitted, as indicated by the metadata fields 'dataFormat' and 'dataFormatVersion' - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) # example passing only required values which don't have defaults set try: # Submits a document to Avalara E-Invoicing API @@ -437,10 +439,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | **metadata** | [**SubmitDocumentMetadata**](SubmitDocumentMetadata.md)| | **data** | [**object**](object.md)| The document to be submitted, as indicated by the metadata fields 'dataFormat' and 'dataFormatVersion' | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] ### Return type @@ -460,10 +462,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Created | - | -**400** | Bad request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | +**201** | Returns a unique documentId for the submitted document. | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/Identifier.md b/docs/EInvoicing/V1/Identifier.md index 4b1b863..2416959 100644 --- a/docs/EInvoicing/V1/Identifier.md +++ b/docs/EInvoicing/V1/Identifier.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **name** | **str** | Identifier name (e.g., Peppol Participant ID). | **display_name** | **str** | Display name of the identifier. | [optional] **value** | **str** | Value of the identifier. | +**extensions** | [**List[Extension]**](Extension.md) | Optional array used to carry additional metadata or configuration values for the identifier. | [optional] ## Example diff --git a/docs/EInvoicing/V1/InteropApi.md b/docs/EInvoicing/V1/InteropApi.md index 1c908e8..5621756 100644 --- a/docs/EInvoicing/V1/InteropApi.md +++ b/docs/EInvoicing/V1/InteropApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Submit a document -This API used by the interoperability partners to submit a document to their trading partners in Avalara on behalf of their customers. +Upload documents on behalf of interoperability partners and submit them to trading partners through the Avalara platform. ### Example @@ -41,9 +41,9 @@ with Avalara.SDK.ApiClient(configuration) as api_client: api_instance = interop_api.InteropApi(api_client) document_type = 'document_type_example' # str | Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents. interchange_type = 'interchange_type_example' # str | Type of interchange (codes in Avalara system that uniquely identifies a type of interchange). Partners will be configured in Avalara system to send documents belonging to certain types of interchanges. - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\" (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) file_name = None # bytearray | The file to be uploaded (e.g., UBL XML, CII XML). (optional) # example passing only required values which don't have defaults set try: @@ -69,9 +69,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **document_type** | **str**| Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents. | **interchange_type** | **str**| Type of interchange (codes in Avalara system that uniquely identifies a type of interchange). Partners will be configured in Avalara system to send documents belonging to certain types of interchanges. | - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\" | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] **file_name** | [**bytearray**](bytearray.md)| The file to be uploaded (e.g., UBL XML, CII XML). | [optional] ### Return type @@ -92,11 +92,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**202** | Document Accepted. This doesn't mean it is processed. This is just a transport ack. | * X-Correlation-ID -
| -**400** | Bad/Invalid Request. | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**202** | Document accepted for processing. Returns the interchange ID and acceptance message. This is a transport acknowledgment; processing occurs asynchronously. | * X-Correlation-ID -
| +**400** | Bad request. The request is invalid or contains missing or incorrect parameters. | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/Mandate.md b/docs/EInvoicing/V1/Mandate.md index 16b43fe..02485bf 100644 --- a/docs/EInvoicing/V1/Mandate.md +++ b/docs/EInvoicing/V1/Mandate.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **input_data_formats** | [**List[InputDataFormats]**](InputDataFormats.md) | Format and version used when inputting the data | [optional] **output_data_formats** | [**List[OutputDataFormats]**](OutputDataFormats.md) | Lists the supported output document formats for the country mandate. For countries where specifying an output document format is required (e.g., France), this array will contain the applicable formats. For other countries where output format selection is not necessary, the array will be empty. | [optional] **workflow_ids** | [**List[WorkflowIds]**](WorkflowIds.md) | Workflow ID list | [optional] +**supported_document_statuses** | [**List[SupportedDocumentStatuses]**](SupportedDocumentStatuses.md) | List of document statuses defined by the mandate. | [optional] ## Example diff --git a/docs/EInvoicing/V1/MandatesApi.md b/docs/EInvoicing/V1/MandatesApi.md index bedd705..ec2fcbe 100644 --- a/docs/EInvoicing/V1/MandatesApi.md +++ b/docs/EInvoicing/V1/MandatesApi.md @@ -43,11 +43,11 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mandates_api.MandatesApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - mandate_id = 'AD-B2G-PEPPOL' # str | The unique ID for the mandate that was returned in the GET /einvoicing/mandates response body + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + mandate_id = 'AD-B2G-PEPPOL' # str | Unique identifier of the mandate returned by the GET /mandates endpoint. document_type = 'ubl-invoice' # str | Select the documentType for which you wish to view the data-input-fields (You may obtain the supported documentTypes from the GET /mandates endpoint) document_version = '2.1' # str | Select the document version of the documentType (You may obtain the supported documentVersion from the GET /mandates endpoint) - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) # example passing only required values which don't have defaults set try: # Returns document field information for a country mandate, a selected document type, and its version @@ -70,11 +70,11 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **mandate_id** | **str**| The unique ID for the mandate that was returned in the GET /einvoicing/mandates response body | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **mandate_id** | **str**| Unique identifier of the mandate returned by the GET /mandates endpoint. | **document_type** | **str**| Select the documentType for which you wish to view the data-input-fields (You may obtain the supported documentTypes from the GET /mandates endpoint) | **document_version** | **str**| Select the document version of the documentType (You may obtain the supported documentVersion from the GET /mandates endpoint) | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] ### Return type @@ -94,10 +94,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad Request | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | +**200** | Returns a MandateDataInputFieldsResponse object containing the input fields and their optionality for the specified mandate, document type, and document version. | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | **404** | Resource not found | - | **500** | Internal Server Error | - | @@ -137,13 +137,13 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = mandates_api.MandatesApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) filter = 'countryMandate eq DE-B2G-PEPPOL' # str | Filter by field name and value. This filter only supports eq and contains. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. (optional) top = 56 # int | The number of items to include in the result. (optional) skip = 56 # int | The number of items to skip in the result. (optional) count = true # bool | When set to true, the count of the collection is also returned in the response body. (optional) - count_only = true # bool | When set to true, only the count of the collection is returned (optional) + count_only = true # bool | When set to true, only the count of the collection is returned. (optional) # example passing only required values which don't have defaults set try: # List country mandates that are supported by the Avalara E-Invoicing platform @@ -166,13 +166,13 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] **filter** | **str**| Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional] **top** | **int**| The number of items to include in the result. | [optional] **skip** | **int**| The number of items to skip in the result. | [optional] **count** | **bool**| When set to true, the count of the collection is also returned in the response body. | [optional] - **count_only** | **bool**| When set to true, only the count of the collection is returned | [optional] + **count_only** | **bool**| When set to true, only the count of the collection is returned. | [optional] ### Return type @@ -192,11 +192,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | +**200** | Returns a MandatesResponse object containing the supported country mandates. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | **404** | Resource not found | - | -**500** | Internal Server Error | - | +**500** | Internal server error. | - | [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/ReportDownloadResponse.md b/docs/EInvoicing/V1/ReportDownloadResponse.md new file mode 100644 index 0000000..31d7420 --- /dev/null +++ b/docs/EInvoicing/V1/ReportDownloadResponse.md @@ -0,0 +1,31 @@ +# ReportDownloadResponse + +Returns a pre-signed URL to download the report file. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_id** | **str** | The unique identifier of the report. | [optional] +**download_url** | **str** | A pre-signed URL to download the report file. This URL is time-limited. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.report_download_response import ReportDownloadResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ReportDownloadResponse from a JSON string +report_download_response_instance = ReportDownloadResponse.from_json(json) +# print the JSON string representation of the object +print(ReportDownloadResponse.to_json()) + +# convert the object into a dict +report_download_response_dict = report_download_response_instance.to_dict() +# create an instance of ReportDownloadResponse from a dict +report_download_response_from_dict = ReportDownloadResponse.from_dict(report_download_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/ReportItem.md b/docs/EInvoicing/V1/ReportItem.md new file mode 100644 index 0000000..f807355 --- /dev/null +++ b/docs/EInvoicing/V1/ReportItem.md @@ -0,0 +1,48 @@ +# ReportItem + +Represents a single report with full details including metadata and associated transaction IDs. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_id** | **str** | The unique ID for this report. | [optional] +**job_id** | **str** | The unique ID of the job that generated this report. | [optional] +**report_generate_date** | **datetime** | The date and time when the report was generated. | [optional] +**report_from** | **date** | The start date of the reporting period. | [optional] +**report_to** | **date** | The end date of the reporting period. | [optional] +**country_code** | **str** | The two-letter ISO-3166 country code for which this report was generated. | [optional] +**country_mandate** | **str** | The e-invoicing mandate for the specified country. | [optional] +**document_type** | **str** | The type of document covered by this report. | [optional] +**document_sub_type** | **str** | The sub-type of the document. | [optional] +**report_reference** | **str** | An internal reference path for the report. | [optional] +**report_name** | **str** | The name of the report file. | [optional] +**status** | **str** | The current status of the report. Possible values include: PENDING, PROCESSING, COMPLETED, FAILED, SENT_TO_PPF, ERROR. | [optional] +**report_format_mimetypes** | **str** | The MIME type of the report file. | [optional] +**tenant_id** | **str** | The tenant identifier associated with this report. | [optional] +**ta_name** | **str** | The name of the tax authority for this report. | [optional] +**tax_invoice_amount** | **float** | The total invoice amount covered by this report. | [optional] +**total_tax_amount** | **float** | The total tax amount covered by this report. | [optional] +**metadata** | **object** | Additional report metadata (free-form JSON). Contents vary by country mandate. | [optional] +**transaction_ids** | **List[str]** | List of transaction IDs associated with this report. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.report_item import ReportItem + +# TODO update the JSON string below +json = "{}" +# create an instance of ReportItem from a JSON string +report_item_instance = ReportItem.from_json(json) +# print the JSON string representation of the object +print(ReportItem.to_json()) + +# convert the object into a dict +report_item_dict = report_item_instance.to_dict() +# create an instance of ReportItem from a dict +report_item_from_dict = ReportItem.from_dict(report_item_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/ReportListResponse.md b/docs/EInvoicing/V1/ReportListResponse.md new file mode 100644 index 0000000..32208dc --- /dev/null +++ b/docs/EInvoicing/V1/ReportListResponse.md @@ -0,0 +1,32 @@ +# ReportListResponse + +Returns the requested list of reports matching the query parameters. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recordset_count** | **str** | Count of reports matching the filter for the given query. Present when the request includes $count=true. | [optional] +**next_link** | **str** | URL to retrieve the next page of results when more items match the query. Omitted or null when there is no next page. | [optional] +**value** | [**List[ReportItem]**](ReportItem.md) | Array of reports matching the query parameters. | + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.report_list_response import ReportListResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ReportListResponse from a JSON string +report_list_response_instance = ReportListResponse.from_json(json) +# print the JSON string representation of the object +print(ReportListResponse.to_json()) + +# convert the object into a dict +report_list_response_dict = report_list_response_instance.to_dict() +# create an instance of ReportListResponse from a dict +report_list_response_from_dict = ReportListResponse.from_dict(report_list_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/ReportsApi.md b/docs/EInvoicing/V1/ReportsApi.md new file mode 100644 index 0000000..d1477d3 --- /dev/null +++ b/docs/EInvoicing/V1/ReportsApi.md @@ -0,0 +1,290 @@ +# Avalara.SDK.ReportsApi + +All URIs are relative to *https://api.sbx.avalara.com/einvoicing* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**download_report**](ReportsApi.md#download_report) | **GET** /reports/{reportId}/$download | Returns a pre-signed download URL for a report +[**get_report_by_id**](ReportsApi.md#get_report_by_id) | **GET** /reports/{reportId}/status | Retrieves a report by its unique ID +[**get_reports**](ReportsApi.md#get_reports) | **GET** /reports | Returns a list of reports + + +# **download_report** +> ReportDownloadResponse download_report(avalara_version, report_id) + +Returns a pre-signed download URL for a report + +Returns a pre-signed URL to download the report file when it is available. If the report has not yet been generated, a 404 (not found) is returned. + +### Example + +* Bearer (JWT) Authentication (Bearer): + +```python +import time +import Avalara.SDK +from Avalara.SDK.api.EInvoicing.V1 import reports_api +ReportDownloadResponse +ForbiddenError +NotFoundError +from pprint import pprint + +# Define configuration object with parameters specified to your application. +configuration = Avalara.SDK.Configuration( + app_name='test app' + app_version='1.0' + machine_name='some machine' + client_id='' + client_secret='' + environment='sandbox' +) +# Enter a context with an instance of the API client +with Avalara.SDK.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = reports_api.ReportsApi(api_client) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + report_id = 'report_id_example' # str | The unique ID for this report as returned in a GET /reports response. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) + # example passing only required values which don't have defaults set + try: + # Returns a pre-signed download URL for a report + api_response = api_instance.download_report(avalara_version, report_id) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->download_report: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Returns a pre-signed download URL for a report + api_response = api_instance.download_report(avalara_version, report_id, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->download_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **report_id** | **str**| The unique ID for this report as returned in a GET /reports response. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] + +### Return type + +[**ReportDownloadResponse**](ReportDownloadResponse.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Returns a pre-signed URL to download the report. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | +**404** | Report not found or not yet available for download. | - | + +[[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_report_by_id** +> ReportItem get_report_by_id(avalara_version, report_id) + +Retrieves a report by its unique ID + +Retrieves a specific report by its unique identifier. Returns complete report details including metadata, status, and associated information. + +### Example + +* Bearer (JWT) Authentication (Bearer): + +```python +import time +import Avalara.SDK +from Avalara.SDK.api.EInvoicing.V1 import reports_api +BadRequest +ForbiddenError +NotFoundError +ReportItem +from pprint import pprint + +# Define configuration object with parameters specified to your application. +configuration = Avalara.SDK.Configuration( + app_name='test app' + app_version='1.0' + machine_name='some machine' + client_id='' + client_secret='' + environment='sandbox' +) +# Enter a context with an instance of the API client +with Avalara.SDK.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = reports_api.ReportsApi(api_client) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + report_id = 'report_id_example' # str | The unique ID for this report as returned in a GET /reports response. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) + # example passing only required values which don't have defaults set + try: + # Retrieves a report by its unique ID + api_response = api_instance.get_report_by_id(avalara_version, report_id) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->get_report_by_id: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Retrieves a report by its unique ID + api_response = api_instance.get_report_by_id(avalara_version, report_id, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->get_report_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **report_id** | **str**| The unique ID for this report as returned in a GET /reports response. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] + +### Return type + +[**ReportItem**](ReportItem.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Report found and returned successfully. | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | +**404** | Report not found. | - | + +[[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_reports** +> ReportListResponse get_reports(avalara_version) + +Returns a list of reports + +Retrieves all reports with optional filtering, paging, and sorting. Results are filtered by tenant. Supports OData-style filtering using the $filter parameter. Use $top and $skip for paging; when more results exist, the response includes @nextLink to fetch the next page. Default sort order is by report generation date (descending). + +### Example + +* Bearer (JWT) Authentication (Bearer): + +```python +import time +import Avalara.SDK +from Avalara.SDK.api.EInvoicing.V1 import reports_api +BadRequest +ReportListResponse +ForbiddenError +from pprint import pprint + +# Define configuration object with parameters specified to your application. +configuration = Avalara.SDK.Configuration( + app_name='test app' + app_version='1.0' + machine_name='some machine' + client_id='' + client_secret='' + environment='sandbox' +) +# Enter a context with an instance of the API client +with Avalara.SDK.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = reports_api.ReportsApi(api_client) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) + filter = 'status eq 'COMPLETED'' # str | OData-style filter expression. Supports operators: eq, ne, gt, ge, lt, le, like, ilike, contains. Examples: status eq 'COMPLETED', reportGenerateDate gt '2025-11-01', transactionIds contains 'TXN-2025-001' (optional) + top = 56 # int | The number of items to include in the result. (optional) + skip = 56 # int | The number of items to skip in the result. (optional) + count = 'true' # str | When set to true, the response body also includes the count of items in the collection. (optional) + count_only = 'false' # str | When set to true, the response returns only the count of items in the collection. (optional) + orderby = 'reportGenerateDate desc' # str | OData-style orderby expression. Format: 'field asc' or 'field desc'. Default: reportGenerateDate desc (optional) if omitted the server will use the default value of 'reportGenerateDate desc' + # example passing only required values which don't have defaults set + try: + # Returns a list of reports + api_response = api_instance.get_reports(avalara_version) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->get_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Returns a list of reports + api_response = api_instance.get_reports(avalara_version, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id, filter=filter, top=top, skip=skip, count=count, count_only=count_only, orderby=orderby) + pprint(api_response) + except Avalara.SDK.ApiException as e: + print("Exception when calling ReportsApi->get_reports: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] + **filter** | **str**| OData-style filter expression. Supports operators: eq, ne, gt, ge, lt, le, like, ilike, contains. Examples: status eq 'COMPLETED', reportGenerateDate gt '2025-11-01', transactionIds contains 'TXN-2025-001' | [optional] + **top** | **int**| The number of items to include in the result. | [optional] + **skip** | **int**| The number of items to skip in the result. | [optional] + **count** | **str**| When set to true, the response body also includes the count of items in the collection. | [optional] + **count_only** | **str**| When set to true, the response returns only the count of items in the collection. | [optional] + **orderby** | **str**| OData-style orderby expression. Format: 'field asc' or 'field desc'. Default: reportGenerateDate desc | [optional] if omitted the server will use the default value of 'reportGenerateDate desc' + +### Return type + +[**ReportListResponse**](ReportListResponse.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Reports retrieved successfully. | - | +**400** | Bad request. | - | +**401** | Unauthorized. | - | +**403** | Forbidden. | - | + +[[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + diff --git a/docs/EInvoicing/V1/StatusEvent.md b/docs/EInvoicing/V1/StatusEvent.md index e43f526..935ff12 100644 --- a/docs/EInvoicing/V1/StatusEvent.md +++ b/docs/EInvoicing/V1/StatusEvent.md @@ -6,10 +6,11 @@ Displays when a status event occurred Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**event_date_time** | **str** | The date and time when the status event occured, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] +**event_date_time** | **str** | The date and time when the status event occurred, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] **message** | **str** | A message describing the status event | [optional] **response_key** | **str** | The type of number or acknowledgement returned by the tax authority (if applicable). For example, it could be an identification key, acknowledgement code, or any other relevant identifier. | [optional] **response_value** | **str** | The corresponding value associated with the response key. This value is provided by the tax authority in response to the event. | [optional] +**category** | **str** | Represents the functional area or process stage where the status event occurred. Useful for grouping related events such as document processing, transmission, or validation. | [optional] ## Example diff --git a/docs/EInvoicing/V1/SubscriptionsApi.md b/docs/EInvoicing/V1/SubscriptionsApi.md index 646369e..3048e35 100644 --- a/docs/EInvoicing/V1/SubscriptionsApi.md +++ b/docs/EInvoicing/V1/SubscriptionsApi.md @@ -5,8 +5,8 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_webhook_subscription**](SubscriptionsApi.md#create_webhook_subscription) | **POST** /webhooks/subscriptions | Create a subscription to events -[**delete_webhook_subscription**](SubscriptionsApi.md#delete_webhook_subscription) | **DELETE** /webhooks/subscriptions/{subscription-id} | Unsubscribe from events -[**get_webhook_subscription**](SubscriptionsApi.md#get_webhook_subscription) | **GET** /webhooks/subscriptions/{subscription-id} | Get details of a subscription +[**delete_webhook_subscription**](SubscriptionsApi.md#delete_webhook_subscription) | **DELETE** /webhooks/subscriptions/{subscriptionId} | Unsubscribe from events +[**get_webhook_subscription**](SubscriptionsApi.md#get_webhook_subscription) | **GET** /webhooks/subscriptions/{subscriptionId} | Get details of a subscription [**list_webhook_subscriptions**](SubscriptionsApi.md#list_webhook_subscriptions) | **GET** /webhooks/subscriptions | List all subscriptions @@ -15,7 +15,7 @@ Method | HTTP request | Description Create a subscription to events -Create a subscription to events exposed by registered systems. +Create a new webhook subscription and return the created subscription details. ### Example @@ -43,7 +43,7 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = subscriptions_api.SubscriptionsApi(api_client) - avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.4\". + avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.6\". subscription_registration = Avalara.SDK.SubscriptionRegistration() # SubscriptionRegistration | x_correlation_id = 'x_correlation_id_example' # str | A unique identifier for tracking the request and its response (optional) x_avalara_client = 'x_avalara_client_example' # str | Client application identification (optional) @@ -69,7 +69,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The version of the API to use, e.g., \"1.4\". | + **avalara_version** | **str**| The version of the API to use, e.g., \"1.6\". | **subscription_registration** | [**SubscriptionRegistration**](SubscriptionRegistration.md)| | **x_correlation_id** | **str**| A unique identifier for tracking the request and its response | [optional] **x_avalara_client** | **str**| Client application identification | [optional] @@ -92,10 +92,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Subscribed successfully | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**400** | Invalid input | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**401** | Not authenticated | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**403** | Access token does not have the required scope | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**201** | Subscription created successfully. Returns the created SubscriptionDetail object. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**400** | Bad request. The request payload is invalid or contains missing required fields. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**401** | Unauthorized. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**403** | Forbidden. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -104,7 +104,7 @@ Name | Type | Description | Notes Unsubscribe from events -Remove a subscription from the webhooks dispatch service. All events and subscriptions are also deleted. +Delete the specified webhook subscription. ### Example @@ -130,8 +130,8 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = subscriptions_api.SubscriptionsApi(api_client) - subscription_id = 'subscription_id_example' # str | - avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.4\". + subscription_id = 'subscription_id_example' # str | Unique identifier of the subscription. + avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.6\". x_correlation_id = 'x_correlation_id_example' # str | A unique identifier for tracking the request and its response (optional) x_avalara_client = 'x_avalara_client_example' # str | Client application identification (optional) # example passing only required values which don't have defaults set @@ -154,8 +154,8 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| | - **avalara_version** | **str**| The version of the API to use, e.g., \"1.4\". | + **subscription_id** | **str**| Unique identifier of the subscription. | + **avalara_version** | **str**| The version of the API to use, e.g., \"1.6\". | **x_correlation_id** | **str**| A unique identifier for tracking the request and its response | [optional] **x_avalara_client** | **str**| Client application identification | [optional] @@ -177,10 +177,10 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Unsubscribed successfully | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**401** | Not authenticated | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**403** | Access token does not have the required scope | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**404** | Subscription not found | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**204** | Subscription deleted successfully. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**401** | Unauthorized. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**403** | Forbidden. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**404** | Subscription not found for the specified subscriptionId. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -216,8 +216,8 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = subscriptions_api.SubscriptionsApi(api_client) - subscription_id = 'subscription_id_example' # str | - avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.4\". + subscription_id = 'subscription_id_example' # str | Unique identifier of the subscription. + avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.6\". x_correlation_id = 'x_correlation_id_example' # str | A unique identifier for tracking the request and its response (optional) x_avalara_client = 'x_avalara_client_example' # str | Client application identification (optional) # example passing only required values which don't have defaults set @@ -242,8 +242,8 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| | - **avalara_version** | **str**| The version of the API to use, e.g., \"1.4\". | + **subscription_id** | **str**| Unique identifier of the subscription. | + **avalara_version** | **str**| The version of the API to use, e.g., \"1.6\". | **x_correlation_id** | **str**| A unique identifier for tracking the request and its response | [optional] **x_avalara_client** | **str**| Client application identification | [optional] @@ -265,10 +265,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Subscription details retrieved successfully | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**401** | Not authenticated | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**403** | Access token does not have the required scope | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**404** | Subscription not found | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**200** | Returns the SubscriptionDetail object for the specified subscriptionId. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**401** | Unauthorized. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**403** | Forbidden. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**404** | Subscription not found for the specified subscriptionId. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -277,7 +277,7 @@ Name | Type | Description | Notes List all subscriptions -Retrieve a list of all subscriptions. +Retrieve a list of webhook subscriptions. ### Example @@ -304,7 +304,7 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = subscriptions_api.SubscriptionsApi(api_client) - avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.4\". + avalara_version = 'avalara_version_example' # str | The version of the API to use, e.g., \"1.6\". x_correlation_id = 'x_correlation_id_example' # str | A unique identifier for tracking the request and its response (optional) x_avalara_client = 'x_avalara_client_example' # str | Client application identification (optional) top = 56 # int | The number of items to include in the result. (optional) @@ -333,7 +333,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The version of the API to use, e.g., \"1.4\". | + **avalara_version** | **str**| The version of the API to use, e.g., \"1.6\". | **x_correlation_id** | **str**| A unique identifier for tracking the request and its response | [optional] **x_avalara_client** | **str**| Client application identification | [optional] **top** | **int**| The number of items to include in the result. | [optional] @@ -359,10 +359,10 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | A list of subscriptions | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**401** | Not authenticated | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**403** | Access token does not have the required scope | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| -**500** | Internal server error | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**200** | Returns a list of webhook subscriptions in a SubscriptionListResponse object. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**401** | Unauthorized. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**403** | Forbidden. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| +**500** | Internal server error. | * X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/SupportedDocumentStatuses.md b/docs/EInvoicing/V1/SupportedDocumentStatuses.md new file mode 100644 index 0000000..e3aa23c --- /dev/null +++ b/docs/EInvoicing/V1/SupportedDocumentStatuses.md @@ -0,0 +1,31 @@ +# SupportedDocumentStatuses + +Represents a document status defined by the mandate. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The name of the status (e.g., Approved, Fully Paid). | [optional] +**description** | **str** | Explanation of what the status means. | [optional] + +## Example + +```python +from Avalara.SDK.models.EInvoicing.V1.supported_document_statuses import SupportedDocumentStatuses + +# TODO update the JSON string below +json = "{}" +# create an instance of SupportedDocumentStatuses from a JSON string +supported_document_statuses_instance = SupportedDocumentStatuses.from_json(json) +# print the JSON string representation of the object +print(SupportedDocumentStatuses.to_json()) + +# convert the object into a dict +supported_document_statuses_dict = supported_document_statuses_instance.to_dict() +# create an instance of SupportedDocumentStatuses from a dict +supported_document_statuses_from_dict = SupportedDocumentStatuses.from_dict(supported_document_statuses_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EInvoicing/V1/TaxIdentifierSchemaByCountry200Response.md b/docs/EInvoicing/V1/TaxIdentifierSchemaByCountry200Response.md index 69431e3..eabdb34 100644 --- a/docs/EInvoicing/V1/TaxIdentifierSchemaByCountry200Response.md +++ b/docs/EInvoicing/V1/TaxIdentifierSchemaByCountry200Response.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **country_code** | **str** | The two-letter ISO-3166 country code of the tax identifier. | +**schema_type** | **str** | The type of schema returned: \"request\" or \"response\". | **var_schema** | **object** | The JSON Schema definition, following Draft-07 specification, used to validate tax identifier data. | ## Example diff --git a/docs/EInvoicing/V1/TaxIdentifiersApi.md b/docs/EInvoicing/V1/TaxIdentifiersApi.md index 602acba..3825beb 100644 --- a/docs/EInvoicing/V1/TaxIdentifiersApi.md +++ b/docs/EInvoicing/V1/TaxIdentifiersApi.md @@ -4,16 +4,16 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing* Method | HTTP request | Description ------------- | ------------- | ------------- -[**tax_identifier_schema_by_country**](TaxIdentifiersApi.md#tax_identifier_schema_by_country) | **GET** /tax-identifiers/schema | Returns the tax identifier request & response schema for a specific country. +[**tax_identifier_schema_by_country**](TaxIdentifiersApi.md#tax_identifier_schema_by_country) | **GET** /tax-identifiers/schema | Returns the tax identifier request and response schema for a specific country. [**validate_tax_identifier**](TaxIdentifiersApi.md#validate_tax_identifier) | **POST** /tax-identifiers/validate | Validates a tax identifier. # **tax_identifier_schema_by_country** > TaxIdentifierSchemaByCountry200Response tax_identifier_schema_by_country(avalara_version, country_code) -Returns the tax identifier request & response schema for a specific country. +Returns the tax identifier request and response schema for a specific country. -This endpoint retrieves the request and response schema required to validate tax identifiers based on a specific country's requirements. This can include both standard fields and any additional parameters required by the respective country's tax authority. +Returns the tax identifier request and response schema for a specific country. ### Example @@ -40,14 +40,14 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tax_identifiers_api.TaxIdentifiersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - country_code = 'DE' # str | The two-letter ISO-3166 country code for which the schema should be retrieved. - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) - type = 'request' # str | Specifies whether to return the request or response schema. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + country_code = 'DE' # str | Two-letter ISO 3166 country code for which to retrieve the schema (for example \"DE\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) + type = 'request' # str | Specifies which schema to return: \"request\" to receive the request validation schema or \"response\" to receive the response validation schema. (optional) # example passing only required values which don't have defaults set try: - # Returns the tax identifier request & response schema for a specific country. + # Returns the tax identifier request and response schema for a specific country. api_response = api_instance.tax_identifier_schema_by_country(avalara_version, country_code) pprint(api_response) except Avalara.SDK.ApiException as e: @@ -56,7 +56,7 @@ with Avalara.SDK.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Returns the tax identifier request & response schema for a specific country. + # Returns the tax identifier request and response schema for a specific country. api_response = api_instance.tax_identifier_schema_by_country(avalara_version, country_code, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id, type=type) pprint(api_response) except Avalara.SDK.ApiException as e: @@ -67,11 +67,11 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **country_code** | **str**| The two-letter ISO-3166 country code for which the schema should be retrieved. | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] - **type** | **str**| Specifies whether to return the request or response schema. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **country_code** | **str**| Two-letter ISO 3166 country code for which to retrieve the schema (for example \"DE\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] + **type** | **str**| Specifies which schema to return: \"request\" to receive the request validation schema or \"response\" to receive the response validation schema. | [optional] ### Return type @@ -91,11 +91,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | * X-Correlation-Id -
| -**400** | Invalid request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Returns an object containing countryCode, schemaType, and schema. The schema property contains a JSON Schema (Draft-07) used to validate tax identifier requests or responses for the specified country. | * X-Correlation-ID -
| +**400** | Invalid request | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -132,10 +132,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = tax_identifiers_api.TaxIdentifiersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). tax_identifier_request = {"countryCode":"DE","identifierType":"vat","identifier":"123456789"} # TaxIdentifierRequest | - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Validates a tax identifier. @@ -158,10 +158,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | **tax_identifier_request** | [**TaxIdentifierRequest**](TaxIdentifierRequest.md)| | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -181,12 +181,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success response. | * X-Correlation-Id -
| -**400** | Invalid request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**429** | Rate limit exceeded | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Validation completed. Returns a TaxIdentifierResponse object that includes countryCode and a value object with identifierType, identifier, and optional extensions when available. | * X-Correlation-ID -
| +**400** | Bad request. The request is invalid or contains missing or incorrect parameters. | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**429** | Rate limit exceeded. | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/docs/EInvoicing/V1/TradingPartnersApi.md b/docs/EInvoicing/V1/TradingPartnersApi.md index 457c60d..f9a2af6 100644 --- a/docs/EInvoicing/V1/TradingPartnersApi.md +++ b/docs/EInvoicing/V1/TradingPartnersApi.md @@ -47,12 +47,12 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - name = 'Automotive Companies in London Search' # str | A human-readable name for the batch search. + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + name = 'Automotive Companies in London Search' # str | A human-readable name for the batch search. notification_email = 'user@example.com' # str | The email address to which a notification will be sent once the batch search is complete. file = None # bytearray | CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Handles batch search requests by uploading a file containing search parameters. @@ -75,12 +75,12 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **name** | **str**| A <b>human-readable</b> name for the batch search. | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **name** | **str**| A human-readable name for the batch search. | **notification_email** | **str**| The email address to which a notification will be sent once the batch search is complete. | **file** | [**bytearray**](bytearray.md)| CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -100,11 +100,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**202** | Batch search file accepted for processing the search. | * X-Correlation-Id -
| -**400** | Invalid request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**202** | Batch search file accepted for processing the search. | * X-Correlation-ID -
| +**400** | Invalid request | * X-Correlation-ID -
| +**401** | Unauthorized | * X-Correlation-ID -
| +**403** | Forbidden | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -141,10 +141,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - trading_partner = {"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445"}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner | - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + trading_partner = {"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner | + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Creates a new trading partner. @@ -167,10 +167,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | **trading_partner** | [**TradingPartner**](TradingPartner.md)| | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -190,12 +190,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | The trading partner has been successfully created. | * X-Correlation-Id -
| -**400** | Bad request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**409** | Conflict | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**201** | The trading partner has been successfully created. | * X-Correlation-ID -
| +**400** | Bad request | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**409** | Conflict | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -204,7 +204,7 @@ Name | Type | Description | Notes Creates a batch of multiple trading partners. -This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed. +This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or a 1 MB request payload. ### Example @@ -232,10 +232,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - create_trading_partners_batch_request = {"value":[{"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445"}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]}]} # CreateTradingPartnersBatchRequest | - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + create_trading_partners_batch_request = {"value":[{"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]}]} # CreateTradingPartnersBatchRequest | + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Creates a batch of multiple trading partners. @@ -258,10 +258,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | **create_trading_partners_batch_request** | [**CreateTradingPartnersBatchRequest**](CreateTradingPartnersBatchRequest.md)| | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -281,13 +281,13 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Batch processing completed | * X-Correlation-Id -
| -**400** | Bad request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**409** | Conflict | * X-Correlation-Id -
| -**413** | ContentTooLarge | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Batch processing completed. Returns a list of created trading partners. | * X-Correlation-ID -
| +**400** | Bad request | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**409** | Conflict | * X-Correlation-ID -
| +**413** | ContentTooLarge | * X-Correlation-ID -
| +**500** | Internal server error | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -322,10 +322,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - id = 'id_example' # str | The ID of the trading partner which is being deleted. - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + id = 'id_example' # str | Unique identifier of the trading partner. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Deletes a trading partner using ID. @@ -346,10 +346,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **id** | **str**| The ID of the trading partner which is being deleted. | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **id** | **str**| Unique identifier of the trading partner. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -369,11 +369,11 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Trading partner deleted successfully. | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**404** | NotFound | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**204** | Trading partner deleted successfully. | * X-Correlation-ID -
| +**401** | Unauthorized | * X-Correlation-ID -
| +**403** | Forbidden | * X-Correlation-ID -
| +**404** | NotFound | * X-Correlation-ID -
| +**500** | Internal server error | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -408,10 +408,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | The ID of the batch search for which the report should be downloaded. - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | Unique identifier of the batch search for which to download the report. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Downloads batch search results in a csv file. @@ -434,10 +434,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **id** | **str**| The ID of the batch search for which the report should be downloaded. | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **id** | **str**| Unique identifier of the batch search for which to download the report. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -457,11 +457,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful report download Output Constraints: - Maximum of 1000 query results returned in the CSV | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**404** | Report not found | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Successful report download. Returns a CSV file containing up to 1,000 query results. | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**404** | Report not found | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -498,10 +498,10 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | The ID of the batch search that was submitted earlier. - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | Unique identifier of the batch search. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Returns the batch search details using ID. @@ -524,10 +524,10 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **id** | **str**| The ID of the batch search that was submitted earlier. | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **id** | **str**| Unique identifier of the batch search. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -547,11 +547,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The batch search details for a given ID. | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**404** | Report not found | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Returns the batch search details for the specified ID. | * X-Correlation-ID -
| +**401** | Unauthorized | * X-Correlation-ID -
| +**403** | Forbidden | * X-Correlation-ID -
| +**404** | Report not found | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -587,14 +587,14 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - filter = 'name eq 'Batch_Search_Import_V4'' # str | Filters the results by field name. Only the eq operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + filter = 'name eq 'Batch_Search_Import_V4'' # str | Filters the results by field name. Only the eq operator and the name field are supported. For more information, refer to the Avalara filtering guide. (optional) count = true # bool | When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional) top = 56 # int | The number of items to include in the result. (optional) skip = 56 # int | The number of items to skip in the result. (optional) order_by = 'name desc' # str | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Lists all batch searches that were previously submitted. @@ -617,14 +617,14 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **filter** | **str**| Filters the results by field name. Only the <code>eq</code> operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **filter** | **str**| Filters the results by field name. Only the eq operator and the name field are supported. For more information, refer to the Avalara filtering guide. | [optional] **count** | **bool**| When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional] **top** | **int**| The number of items to include in the result. | [optional] **skip** | **int**| The number of items to skip in the result. | [optional] **order_by** | **str**| The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -644,11 +644,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List of batch searches | * X-Correlation-Id -
| -**400** | Bad request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Returns a collection of batch searches. | * X-Correlation-ID -
| +**400** | Bad request | * X-Correlation-ID -
| +**401** | Unauthorized | * X-Correlation-ID -
| +**403** | Forbidden | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -684,15 +684,15 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - search = 'Acme and 7726627177 or BMW' # str | Search by value supports logical AND / OR operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search). - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - count = true # bool | When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional) - filter = 'network eq 'Peppol' and country eq 'Australia'' # str | Filters the results using the eq operator. Supported fields: network, country, documentType, idType. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + search = 'Acme AND 7726627177 OR BMW' # str | Search by value supports logical AND and OR operators (case-sensitive). Search is performed only over the name and identifier value fields. For more information, refer to the OData query options overview documentation. + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + count = true # bool | When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional) + filter = 'network eq 'Peppol' and country eq 'Australia'' # str | Filters the results using the eq operator. Supported fields include network, country, documentType, and idType. For more information, refer to the Avalara filtering guide. (optional) top = 56 # int | The number of items to include in the result. (optional) skip = 56 # int | The number of items to skip in the result. (optional) - order_by = 'name desc' # str | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + order_by = 'name desc' # str | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Returns a list of participants matching the input query. @@ -715,15 +715,15 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **search** | **str**| Search by value supports logical <code>AND</code> / <code>OR</code> operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search). | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **count** | **bool**| When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional] - **filter** | **str**| Filters the results using the <code>eq</code> operator. Supported fields: <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/). | [optional] + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **search** | **str**| Search by value supports logical AND and OR operators (case-sensitive). Search is performed only over the name and identifier value fields. For more information, refer to the OData query options overview documentation. | + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **count** | **bool**| When set to true, returns the total count of matching records included as @recordSetCount in the response body. | [optional] + **filter** | **str**| Filters the results using the eq operator. Supported fields include network, country, documentType, and idType. For more information, refer to the Avalara filtering guide. | [optional] **top** | **int**| The number of items to include in the result. | [optional] **skip** | **int**| The number of items to skip in the result. | [optional] - **order_by** | **str**| The <code>$orderBy</code> query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **order_by** | **str**| The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -743,11 +743,11 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | * X-Correlation-Id -
| -**400** | Bad request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**200** | Returns a collection of trading partners matching the specified search criteria. | * X-Correlation-ID -
| +**400** | Bad request. | * X-Correlation-ID -
| +**401** | Unauthorized. | * X-Correlation-ID -
| +**403** | Forbidden. | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) @@ -784,11 +784,11 @@ configuration = Avalara.SDK.Configuration( with Avalara.SDK.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = trading_partners_api.TradingPartnersApi(api_client) - avalara_version = '1.4' # str | The HTTP Header meant to specify the version of the API intended to be used. - id = 'id_example' # str | The ID of the trading partner which is being updated. - trading_partner = {"name":"Pineapple Labs ltd","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445"}],"address":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner | - x_avalara_client = 'John's E-Invoicing-API Client' # str | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". (optional) - x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | The caller can use this as an identifier to use as a correlation id to trace the call. (optional) + avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\"). + id = 'id_example' # str | Unique identifier of the trading partner. + trading_partner = {"name":"Pineapple Labs ltd","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"address":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner | + x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional) + x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional) # example passing only required values which don't have defaults set try: # Updates a trading partner using ID. @@ -811,11 +811,11 @@ with Avalara.SDK.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **avalara_version** | **str**| The HTTP Header meant to specify the version of the API intended to be used. | - **id** | **str**| The ID of the trading partner which is being updated. | + **avalara_version** | **str**| Header that specifies the API version to use (for example \"1.6\"). | + **id** | **str**| Unique identifier of the trading partner. | **trading_partner** | [**TradingPartner**](TradingPartner.md)| | - **x_avalara_client** | **str**| You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\". | [optional] - **x_correlation_id** | **str**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] + **x_avalara_client** | **str**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional] + **x_correlation_id** | **str**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional] ### Return type @@ -836,12 +836,12 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | The trading partner has been successfully created. | - | -**400** | Bad request | * X-Correlation-Id -
| -**401** | Unauthorized | * X-Correlation-Id -
| -**403** | Forbidden | * X-Correlation-Id -
| -**404** | NotFound | * X-Correlation-Id -
| -**409** | Conflict | * X-Correlation-Id -
| -**500** | Internal server error | * X-Correlation-Id -
| +**400** | Bad request | * X-Correlation-ID -
| +**401** | Unauthorized | * X-Correlation-ID -
| +**403** | Forbidden | * X-Correlation-ID -
| +**404** | NotFound | * X-Correlation-ID -
| +**409** | Conflict | * X-Correlation-ID -
| +**500** | Internal server error. | * X-Correlation-ID -
| [[Back to top]](#) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) diff --git a/setup.py b/setup.py index 224ca5e..01e4fae 100644 --- a/setup.py +++ b/setup.py @@ -17,14 +17,14 @@ See the License for the specific language governing permissions and limitations under the License. - Avalara 1099 & W-9 API Definition - ## 🔐 Authentication Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*. [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/) [Test your credentials](https://developer.avalara.com/avatax/test-credentials/) ## 📘 API & SDK Documentation [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services) [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget) + Avalara E-Invoicing API + An API that supports sending data for an E-Invoicing compliance use-case. @author Sachin Baijal @author Jonathan Wenger @copyright 2022 Avalara, Inc. @license https://www.apache.org/licenses/LICENSE-2.0 -@version 25.11.2 +@version 26.4.0 @link https://github.com/avadev/AvaTax-REST-V3-Python-SDK """ @@ -40,10 +40,10 @@ from setuptools import setup, find_namespace_packages NAME = "Avalara.SDK" -VERSION = "25.11.2" +VERSION = "26.4.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ - "urllib3 >= 2.5.0", + "urllib3 >= 1.25.3, < 2.1.0", "python-dateutil", "pydantic >= 2", ] @@ -51,15 +51,14 @@ setup( name=NAME, version=VERSION, - description="Avalara 1099 & W-9 API Definition", - author="Developer Support", - author_email="support@avalara.com", + description="Avalara E-Invoicing API", + author="OpenAPI Generator community", + author_email="team@openapitools.org", url="", - keywords=["OpenAPI", "OpenAPI-Generator", "Avalara 1099 & W-9 API Definition"], + keywords=["OpenAPI", "OpenAPI-Generator", "Avalara E-Invoicing API"], install_requires=REQUIRES, packages=find_namespace_packages(include=["Avalara.*"], exclude=["test", "tests"]), include_package_data=True, - license="Apache 2.0", long_description_content_type='text/markdown', long_description="""\ SDK for Avalara Services for client use. # noqa: E501