avalara_sdk 24.2.29 → 24.12.0

data/docs/EInvoicing/V1/DocumentsApi.md

@@ -5,8 +5,9 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**download_document**](DocumentsApi.md#download_document) | **GET** /documents/{documentId}/$download | Returns a copy of the document |
+| [**fetch_documents**](DocumentsApi.md#fetch_documents) | **POST** /documents/$fetch | Fetch the inbound document from a tax authority |
 | [**get_document_list**](DocumentsApi.md#get_document_list) | **GET** /documents | Returns a summary of documents for a date range |
-| [**get_document_status**](DocumentsApi.md#get_document_status) | **GET** /document/{documentId}/status | Checks the status of a document |
+| [**get_document_status**](DocumentsApi.md#get_document_status) | **GET** /documents/{documentId}/status | Checks the status of a document |
 | [**submit_document**](DocumentsApi.md#submit_document) | **POST** /documents | Submits a document to Avalara E-Invoicing API |
 
 
@@ -16,7 +17,7 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
 
 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.
+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.
 
 ### Examples
 
@@ -36,11 +37,11 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::DocumentsApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 accept = 'application/pdf' # String | This header indicates the MIME type of the document
 document_id = 'document_id_example' # String | The unique ID for this document that was returned in the POST /einvoicing/document response body
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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.
 }
 
 begin
@@ -77,7 +78,7 @@ end
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
 | **accept** | **String** | This header indicates the MIME type of the document |  |
 | **document_id** | **String** | The unique ID for this document that was returned in the POST /einvoicing/document response body |  |
-| **x_avalara_client** | **String** | 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** | **String** | 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] |
 
 ### Return type
 
@@ -93,6 +94,87 @@ end
 - **Accept**: application/pdf, application/xml, application/json
 
 
+## fetch_documents
+
+> <DocumentFetch> fetch_documents(avalara_version, document_fetch_request, opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk::EInvoicing::V1.configure do |config|
+  # See Documentation for Authorization section in main README.md for more auth examples.
+  config.bearer_token='<Your Avalara Identity Access Token>'
+  config.environment='sandbox'
+  config.app_name='testApp'
+  config.app_version='1.2.3'
+  config.machine_name='testMachine'
+end
+
+api_client = AvalaraSdk::ApiClient.new config
+api_instance = AvalaraSdk::EInvoicing::V1::DocumentsApi.new api_client
+
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
+document_fetch_request = AvalaraSdk::EInvoicing::V1::DocumentFetchRequest.new # DocumentFetchRequest | 
+opts = {
+  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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.
+}
+
+begin
+  # Fetch the inbound document from a tax authority
+  result = api_instance.fetch_documents(avalara_version, document_fetch_request, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling DocumentsApi->fetch_documents: #{e}"
+end
+```
+
+#### Using the fetch_documents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DocumentFetch>, Integer, Hash)> fetch_documents_with_http_info(avalara_version, document_fetch_request, opts)
+
+```ruby
+begin
+  # Fetch the inbound document from a tax authority
+  data, status_code, headers = api_instance.fetch_documents_with_http_info(avalara_version, document_fetch_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocumentFetch>
+rescue AvalaraSdk::EInvoicing::V1::ApiError => e
+  puts "Error when calling DocumentsApi->fetch_documents_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
+| **document_fetch_request** | [**DocumentFetchRequest**](DocumentFetchRequest.md) |  |  |
+| **x_avalara_client** | **String** | 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] |
+
+### Return type
+
+[**DocumentFetch**](DocumentFetch.md)
+
+### Authorization
+
+[Bearer](../../../README.md#documentation-for-authorization)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_document_list
 
 > <DocumentListResponse> get_document_list(avalara_version, opts)
@@ -119,15 +201,15 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::DocumentsApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client', # String | 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client', # String | 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.
   start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Start date of documents to return. This defaults to the previous month.
   end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | End date of documents to return. This defaults to the current date.
   flow: 'out', # String | Optionally filter by document direction, where issued = `out` and received = `in`
   count: 'true', # String | When set to true, the count of the collection is also returned in the response body
   count_only: 'false', # String | When set to true, only the count of the collection is returned
-  filter: 'id eq 2023-02-000016', # String | 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.
+  filter: 'id eq 52f60401-44d0-4667-ad47-4afe519abb53', # String | 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.
   top: 10, # Float | If nonzero, return no more than this number of results. Used with <code>$skip</code> to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 200 records.
   skip: '10' # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
 }
@@ -164,7 +246,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
-| **x_avalara_client** | **String** | 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 \&quot;Fingerprint\&quot; | [optional] |
+| **x_avalara_client** | **String** | 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** | **Time** | Start date of documents to return. This defaults to the previous month. | [optional] |
 | **end_date** | **Time** | End date of documents to return. This defaults to the current date. | [optional] |
 | **flow** | **String** | Optionally filter by document direction, where issued &#x3D; &#x60;out&#x60; and received &#x3D; &#x60;in&#x60; | [optional] |
@@ -214,10 +296,10 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::DocumentsApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 document_id = 'document_id_example' # String | The unique ID for this document that was returned in the POST /einvoicing/documents response body
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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.
 }
 
 begin
@@ -253,7 +335,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
 | **document_id** | **String** | The unique ID for this document that was returned in the POST /einvoicing/documents response body |  |
-| **x_avalara_client** | **String** | 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 \&quot;Fingerprint\&quot; | [optional] |
+| **x_avalara_client** | **String** | 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] |
 
 ### Return type
 
@@ -275,7 +357,7 @@ end
 
 Submits a document to Avalara E-Invoicing API
 
-For both e-invoices and credit notes, when a document is sent to this endpoint, it generates an invoice or credit note in the required format as mandated by the specified country. Additionally, it initiates the workflow to transmit the generated document to the relevant tax authority, if necessary.<br><br>The response from the endpoint contains a unique document ID, which can be used to request the status of the document and verify if it was successfully accepted at the destination.<br><br>Furthermore, the unique ID enables the download of a copy of the e-invoice or credit note for reference purposes.
+When a UBL document is sent to this endpoint, it generates a document in the required format as mandated by the specified country. Additionally, it initiates the workflow to transmit the generated document to the relevant tax authority, if necessary.<br><br>The response from the endpoint contains a unique document ID, which can be used to request the status of the document and verify if it was successfully accepted at the destination.<br><br>Furthermore, the unique ID enables the download of a copy of the generated document for reference purposes.
 
 ### Examples
 
@@ -295,11 +377,11 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::DocumentsApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 metadata = AvalaraSdk::EInvoicing::V1::SubmitDocumentMetadata.new({workflow_id: 'partner-einvoicing', data_format: 'ubl-invoice', data_format_version: '2.1', country_code: 'SA', country_mandate: 'SA-Phase1-B2B'}) # SubmitDocumentMetadata | 
-data = AvalaraSdk::EInvoicing::V1::SubmitDocumentData.new # SubmitDocumentData | 
+data = 'data_example' # String | The document to be submitted, as indicated by the metadata fields 'dataFormat' and 'dataFormatVersion'
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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.
 }
 
 begin
@@ -335,8 +417,8 @@ end
 | ---- | ---- | ----------- | ----- |
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
 | **metadata** | [**SubmitDocumentMetadata**](SubmitDocumentMetadata.md) |  |  |
-| **data** | [**SubmitDocumentData**](SubmitDocumentData.md) |  |  |
-| **x_avalara_client** | **String** | 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 \&quot;Fingerprint\&quot; | [optional] |
+| **data** | **String** | The document to be submitted, as indicated by the metadata fields &#39;dataFormat&#39; and &#39;dataFormatVersion&#39; |  |
+| **x_avalara_client** | **String** | 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] |
 
 ### Return type
 

data/docs/EInvoicing/V1/ErrorResponse.md

@@ -0,0 +1,24 @@
+# AvalaraSdk::EInvoicing::V1::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **detail** | **String** |  | [optional] |
+| **instance** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::ErrorResponse.new(
+  title: BadInput,
+  status: Error,
+  detail: The input query is invalid.,
+  instance: unknown parameter 'city'
+)
+```
+

data/docs/EInvoicing/V1/FetchDocumentsRequest.md

@@ -0,0 +1,20 @@
+# AvalaraSdk::EInvoicing::V1::FetchDocumentsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<FetchDocumentsRequestDataInner>**](FetchDocumentsRequestDataInner.md) | Array of key-value pairs used to retrieve inbound documents from the Tax Authority | [optional] |
+| **metadata** | [**FetchDocumentsRequestMetadata**](FetchDocumentsRequestMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::FetchDocumentsRequest.new(
+  data: [{"key":"Confirmation_Number","value":"987654321"},{"key":"Customer_VAT_Number","value":"777777715"}],
+  metadata: null
+)
+```
+

data/docs/EInvoicing/V1/FetchDocumentsRequestDataInner.md

@@ -0,0 +1,20 @@
+# AvalaraSdk::EInvoicing::V1::FetchDocumentsRequestDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Descriptor of the identifier |  |
+| **value** | **String** | Value of the identifier |  |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::FetchDocumentsRequestDataInner.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/EInvoicing/V1/FetchDocumentsRequestMetadata.md

@@ -0,0 +1,26 @@
+# AvalaraSdk::EInvoicing::V1::FetchDocumentsRequestMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_id** | **String** | Specifies a unique ID for this workflow. |  |
+| **data_format** | **String** | Specifies the data format for this workflow |  |
+| **data_format_version** | **Float** | Specifies the data format version number |  |
+| **country_code** | **String** | The two-letter ISO-3166 country code for the country for which document is being retrieved |  |
+| **country_mandate** | **String** | The e-invoicing mandate for the specified country |  |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::FetchDocumentsRequestMetadata.new(
+  workflow_id: partner-einvoicing,
+  data_format: ubl-invoice,
+  data_format_version: 2.1,
+  country_code: IL,
+  country_mandate: IL-B2B-CLEARANCE
+)
+```
+

data/docs/EInvoicing/V1/InputDataFormats.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **format** | **String** | Invoice format | [optional] |
+| **format** | **String** | Document format | [optional] |
 | **versions** | **Array<String>** |  | [optional] |
 
 ## Example

data/docs/EInvoicing/V1/InteropApi.md

@@ -0,0 +1,95 @@
+# AvalaraSdk::EInvoicing::V1::InteropApi
+
+All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**submit_interop_document**](InteropApi.md#submit_interop_document) | **POST** /interop/documents | Submit a document |
+
+
+## submit_interop_document
+
+> <SubmitInteropDocument202Response> submit_interop_document(document_type, interchange_type, avalara_version, opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk::EInvoicing::V1.configure do |config|
+  # See Documentation for Authorization section in main README.md for more auth examples.
+  config.bearer_token='<Your Avalara Identity Access Token>'
+  config.environment='sandbox'
+  config.app_name='testApp'
+  config.app_version='1.2.3'
+  config.machine_name='testMachine'
+end
+
+api_client = AvalaraSdk::ApiClient.new config
+api_instance = AvalaraSdk::EInvoicing::V1::InteropApi.new api_client
+
+document_type = 'ubl-invoice-2.1' # String | Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents.
+interchange_type = 'FI-B2B' # String | 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.2' # String | The HTTP Header meant to specify the version of the API intended to be used
+opts = {
+  x_avalara_client: 'John's E-Invoicing-API Client', # String | 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\"
+  x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43', # String | The caller can use this as an identifier to use as a correlation id to trace the call.
+  file_name: File.new('/path/to/some/file') # File | The file to be uploaded (e.g., UBL XML, CII XML).
+}
+
+begin
+  # Submit a document
+  result = api_instance.submit_interop_document(document_type, interchange_type, avalara_version, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling InteropApi->submit_interop_document: #{e}"
+end
+```
+
+#### Using the submit_interop_document_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubmitInteropDocument202Response>, Integer, Hash)> submit_interop_document_with_http_info(document_type, interchange_type, avalara_version, opts)
+
+```ruby
+begin
+  # Submit a document
+  data, status_code, headers = api_instance.submit_interop_document_with_http_info(document_type, interchange_type, avalara_version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubmitInteropDocument202Response>
+rescue AvalaraSdk::EInvoicing::V1::ApiError => e
+  puts "Error when calling InteropApi->submit_interop_document_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_type** | **String** | Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents. |  |
+| **interchange_type** | **String** | 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** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
+| **x_avalara_client** | **String** | 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 \&quot;Fingerprint\&quot; | [optional] |
+| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
+| **file_name** | **File** | The file to be uploaded (e.g., UBL XML, CII XML). | [optional] |
+
+### Return type
+
+[**SubmitInteropDocument202Response**](SubmitInteropDocument202Response.md)
+
+### Authorization
+
+[Bearer](../../../README.md#documentation-for-authorization)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/EInvoicing/V1/Mandate.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **mandate_id** | **String** | Mandate UUID | [optional] |
-| **country_mandate** | **String** | Country mandate name | [optional] |
+| **mandate_id** | **String** | The `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL). Keep in mind the following when specifying a `mandateId`. - A country can have multiple mandate types (B2C, B2B, B2G). - A entity/company can opt in for multiple mandates. - A `mandateId` is the combination of country + mandate type + network/regulation. | [optional] |
+| **country_mandate** | **String** | **[LEGACY]** This field is retained for backward compatibility. It is recommended to use `mandateId` instead. The `countryMandate` similar to the `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL).  | [optional] |
 | **country_code** | **String** | Country code | [optional] |
 | **description** | **String** | Mandate description | [optional] |
 | **supported_by_partner_api** | **Boolean** | Indicates whether this mandate supported by the partner API | [optional] |
@@ -19,12 +19,12 @@
 require 'avalara_sdk'
 
 instance = AvalaraSdk::EInvoicing::V1::Mandate.new(
-  mandate_id: f1768981-7025-468b-9f87-8a8982cd6984,
-  country_mandate: PT-B2C-PDF,
-  country_code: PT,
-  description: The mandate supporting B2B clearance in Germany. This function will return a PDF invoice with the required QR-Codes, ATCUD (as of Jan 2023) and a legal Stamp. The invoice will not be sent to the buyer.,
+  mandate_id: AU-B2G-PEPPOL,
+  country_mandate: AU-B2G-PEPPOL,
+  country_code: AU,
+  description: The mandate supporting B2G eInvoicing in Australia. This function will create a Peppol BIS 3.0 file and sends the invoice to the related recipient via the Peppol network,
   supported_by_partner_api: true,
-  mandate_format: pdf,
+  mandate_format: xml,
   input_data_formats: null,
   workflow_ids: null
 )

data/docs/EInvoicing/V1/MandateDataInputField.md

@@ -0,0 +1,44 @@
+# AvalaraSdk::EInvoicing::V1::MandateDataInputField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_id** | **String** | Field ID | [optional] |
+| **document_type** | **String** | The document type | [optional] |
+| **document_version** | **String** | The document version | [optional] |
+| **path** | **String** | Path to this field | [optional] |
+| **path_type** | **String** | The type of path | [optional] |
+| **field_name** | **String** | Field name | [optional] |
+| **namespace** | [**MandateDataInputFieldNamespace**](MandateDataInputFieldNamespace.md) |  | [optional] |
+| **example_or_fixed_value** | **String** | An example of the content for this field | [optional] |
+| **accepted_values** | **Array<String>** | An Array representing the acceptable values for this field | [optional] |
+| **documentation_link** | **String** | An example of the content for this field | [optional] |
+| **data_type** | **String** | The data type of this field. | [optional] |
+| **description** | **String** | A description of this field | [optional] |
+| **optionality** | **String** | Determines if the field if Required/Conditional/Optional or not required. | [optional] |
+| **cardinality** | **String** | Represents the number of times an element can appear within the document | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::MandateDataInputField.new(
+  field_id: 1,
+  document_type: ubl-inovice,
+  document_version: 2.1,
+  path: Invoice/cbc:CustomizationID,
+  path_type: xpath,
+  field_name: cbc:CustomizationID,
+  namespace: null,
+  example_or_fixed_value: urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0,
+  accepted_values: null,
+  documentation_link: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-CustomizationID,
+  data_type: object,
+  description: Specification identifier: An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.,
+  optionality: Required,
+  cardinality: 1..1
+)
+```
+

data/docs/EInvoicing/V1/MandateDataInputFieldNamespace.md

@@ -0,0 +1,20 @@
+# AvalaraSdk::EInvoicing::V1::MandateDataInputFieldNamespace
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prefix** | **String** | The namespace prefix for the UBL Element | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::EInvoicing::V1::MandateDataInputFieldNamespace.new(
+  prefix: cbc,
+  value: urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2
+)
+```
+

data/docs/EInvoicing/V1/MandatesApi.md

@@ -4,9 +4,95 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**get_mandate_data_input_fields**](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 |
 | [**get_mandates**](MandatesApi.md#get_mandates) | **GET** /mandates | List country mandates that are supported by the Avalara E-Invoicing platform |
 
 
+## get_mandate_data_input_fields
+
+> <Array<MandateDataInputField>> get_mandate_data_input_fields(avalara_version, mandate_id, document_type, document_version, opts)
+
+Returns document field information for a country mandate, a selected document type, and its version
+
+This endpoint provides document field details and the optionality of fields (required, conditional, optional) of different documents supported by the country mandate. Use the GET <code>/mandates</code> endpoint to retrieve all available country mandates, their supported document types and supported versions. You can use the `documentType` and `documentVersion` query parameters to retrieve the input fields for a particular document type and document version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk::EInvoicing::V1.configure do |config|
+  # See Documentation for Authorization section in main README.md for more auth examples.
+  config.bearer_token='<Your Avalara Identity Access Token>'
+  config.environment='sandbox'
+  config.app_name='testApp'
+  config.app_version='1.2.3'
+  config.machine_name='testMachine'
+end
+
+api_client = AvalaraSdk::ApiClient.new config
+api_instance = AvalaraSdk::EInvoicing::V1::MandatesApi.new api_client
+
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
+mandate_id = 'AD-B2G-PEPPOL' # String | The unique ID for the mandate that was returned in the GET /einvoicing/mandates response body
+document_type = 'ubl-invoice' # String | 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' # String | Select the document version of the documentType (You may obtain the supported documentVersion from the GET /mandates endpoint)
+opts = {
+  x_avalara_client: 'John's E-Invoicing-API Client' # String | 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.
+}
+
+begin
+  # Returns document field information for a country mandate, a selected document type, and its version
+  result = api_instance.get_mandate_data_input_fields(avalara_version, mandate_id, document_type, document_version, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling MandatesApi->get_mandate_data_input_fields: #{e}"
+end
+```
+
+#### Using the get_mandate_data_input_fields_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<MandateDataInputField>>, Integer, Hash)> get_mandate_data_input_fields_with_http_info(avalara_version, mandate_id, document_type, document_version, opts)
+
+```ruby
+begin
+  # Returns document field information for a country mandate, a selected document type, and its version
+  data, status_code, headers = api_instance.get_mandate_data_input_fields_with_http_info(avalara_version, mandate_id, document_type, document_version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<MandateDataInputField>>
+rescue AvalaraSdk::EInvoicing::V1::ApiError => e
+  puts "Error when calling MandatesApi->get_mandate_data_input_fields_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
+| **mandate_id** | **String** | The unique ID for the mandate that was returned in the GET /einvoicing/mandates response body |  |
+| **document_type** | **String** | 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** | **String** | Select the document version of the documentType (You may obtain the supported documentVersion from the GET /mandates endpoint) |  |
+| **x_avalara_client** | **String** | 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] |
+
+### Return type
+
+[**Array&lt;MandateDataInputField&gt;**](MandateDataInputField.md)
+
+### Authorization
+
+[Bearer](../../../README.md#documentation-for-authorization)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_mandates
 
 > <MandatesResponse> get_mandates(avalara_version, opts)
@@ -33,9 +119,9 @@ end
 api_client = AvalaraSdk::ApiClient.new config
 api_instance = AvalaraSdk::EInvoicing::V1::MandatesApi.new api_client
 
-avalara_version = '1.0' # String | The HTTP Header meant to specify the version of the API intended to be used
+avalara_version = '1.2' # String | The HTTP Header meant to specify the version of the API intended to be used
 opts = {
-  x_avalara_client: 'John's E-Invoicing-API Client', # String | 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\"
+  x_avalara_client: 'John's E-Invoicing-API Client', # String | 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.
   filter: 'countryMandate eq DE-B2G-PEPPOL', # String | 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.
   top: 10, # Float | If nonzero, return no more than this number of results. Used with <code>$skip</code> to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
   skip: 10, # Float | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
@@ -75,7 +161,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used |  |
-| **x_avalara_client** | **String** | 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 \&quot;Fingerprint\&quot; | [optional] |
+| **x_avalara_client** | **String** | 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** | **String** | Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; and &lt;code&gt;contains&lt;/code&gt;. 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** | **Float** | If nonzero, return no more than this number of results. Used with &lt;code&gt;$skip&lt;/code&gt; to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. | [optional] |
 | **skip** | **Float** | If nonzero, skip this number of results before returning data. Used with &lt;code&gt;$top&lt;/code&gt; to provide pagination for large datasets. | [optional] |

data/docs/EInvoicing/V1/MandatesResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **record_set_count** | **Float** | Total count of results | [optional] |
+| **recordset_count** | **Float** | Total count of results | [optional] |
 | **next_link** | **String** |  | [optional] |
 | **value** | [**Array<Mandate>**](Mandate.md) | Mandates schema | [optional] |
 
@@ -14,7 +14,7 @@
 require 'avalara_sdk'
 
 instance = AvalaraSdk::EInvoicing::V1::MandatesResponse.new(
-  record_set_count: 1,
+  recordset_count: 1,
   next_link: null,
   value: null
 )