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.
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String $filter = "requiredFor/countryMandate eq AU-B2G-PEPPOL"; // String | Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide.
Integer $top = 56; // Integer | The number of items to include in the result.
Integer $skip = 56; // Integer | The number of items to skip in the result.
- Boolean $count = true; // Boolean | When set to true, the count of the collection is also returned in the response body
- Boolean $countOnly = true; // Boolean | When set to true, only the count of the collection is returned
+ Boolean $count = true; // Boolean | When set to true, the response body also includes the count of items in the collection.
+ Boolean $countOnly = true; // Boolean | When set to true, the response returns only the count of items in the collection.
try {
DataInputFieldsResponse result = apiInstance.getDataInputFields(avalaraVersion, xAvalaraClient, $filter, $top, $skip, $count, $countOnly);
System.out.println(result);
@@ -70,13 +70,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
- **xAvalaraClient** | **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 <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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **$filter** | **String**| Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide. | [optional]
**$top** | **Integer**| The number of items to include in the result. | [optional]
**$skip** | **Integer**| The number of items to skip in the result. | [optional]
- **$count** | **Boolean**| When set to true, the count of the collection is also returned in the response body | [optional]
- **$countOnly** | **Boolean**| When set to true, only the count of the collection is returned | [optional]
+ **$count** | **Boolean**| When set to true, the response body also includes the count of items in the collection. | [optional]
+ **$countOnly** | **Boolean**| When set to true, the response returns only the count of items in the collection. | [optional]
### Return type
@@ -95,8 +95,8 @@ Name | Type | Description | Notes
### HTTP response details
| 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. | - |
diff --git a/docs/EInvoicing/V1/DocumentStatusResponse.md b/docs/EInvoicing/V1/DocumentStatusResponse.md
index 5988af3..b6b36ae 100644
--- a/docs/EInvoicing/V1/DocumentStatusResponse.md
+++ b/docs/EInvoicing/V1/DocumentStatusResponse.md
@@ -9,7 +9,8 @@ Returns the current document ID and status
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | The unique ID for this document | [optional] |
-|**status** | **String** | Status of the document | [optional] |
+|**status** | **String** | Document status. See the `supportedDocumentStatuses` field in the GET /mandates response for full status definitions. | [optional] |
+|**businessStatus** | **String** | 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] |
diff --git a/docs/EInvoicing/V1/DocumentSummary.md b/docs/EInvoicing/V1/DocumentSummary.md
index 3f244a9..cd4ffe5 100644
--- a/docs/EInvoicing/V1/DocumentSummary.md
+++ b/docs/EInvoicing/V1/DocumentSummary.md
@@ -12,6 +12,7 @@ Displays a summary of information about the document
|**companyId** | **String** | Unique identifier that represents the company within the system. | [optional] |
|**processDateTime** | **String** | The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] |
|**status** | **String** | The Document status | [optional] |
+|**businessStatus** | **String** | 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] |
|**supplierName** | **String** | The name of the supplier in the transaction | [optional] |
|**customerName** | **String** | The name of the customer in the transaction | [optional] |
|**documentType** | **String** | The document type | [optional] |
@@ -23,6 +24,9 @@ Displays a summary of information about the document
|**countryMandate** | **String** | The e-invoicing mandate for the specified country | [optional] |
|**_interface** | **String** | The interface where the document is sent | [optional] |
|**receiver** | **String** | 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] |
+|**createdAt** | **String** | The date and time when the document was created in the system, displayed in ISO 8601 format with timezone | [optional] |
+|**lastUpdatedAt** | **String** | The date and time when the document was last updated in the system, displayed in ISO 8601 format with timezone | [optional] |
diff --git a/docs/EInvoicing/V1/DocumentsApi.md b/docs/EInvoicing/V1/DocumentsApi.md
index e2592b3..40e85d8 100644
--- a/docs/EInvoicing/V1/DocumentsApi.md
+++ b/docs/EInvoicing/V1/DocumentsApi.md
@@ -18,7 +18,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
@@ -48,10 +48,10 @@ public class Example {
ApiClient apiClient = new ApiClient(configuration);
DocumentsApi apiInstance = new DocumentsApi(apiClient);
- String avalaraVersion = "1.4"; // String | The HTTP Header meant to specify the version of the API intended to be used
- String accept = "application/pdf"; // String | This header indicates the MIME type of the document
- String documentId = "documentId_example"; // String | The unique ID for this document that was returned in the POST /einvoicing/document response body
- String xAvalaraClient = "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.
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String accept = "application/pdf"; // String | Header that specifies the MIME type of the returned document.
+ String documentId = "documentId_example"; // String | The unique documentId returned in the POST /documents response body.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
try {
File result = apiInstance.downloadDocument(avalaraVersion, accept, documentId, xAvalaraClient);
System.out.println(result);
@@ -71,10 +71,10 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **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 |
- **documentId** | **String**| The unique ID for this document that was returned in the POST /einvoicing/document response body |
- **xAvalaraClient** | **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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **accept** | **String**| Header that specifies the MIME type of the returned document. |
+ **documentId** | **String**| The unique documentId returned in the POST /documents response body. |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
### Return type
@@ -93,11 +93,11 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | OK | * Content-type - 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.
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\".
+ OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\".
+ String flow = "out"; // String | Optional filter for document direction: issued uses \"out\" and received uses \"in\".
+ String $count = "true"; // String | When set to true, the response body also includes the count of items in the collection.
+ String $countOnly = "false"; // String | When set to true, the response returns only the count of items in the collection.
+ String $filter = "id eq 52f60401-44d0-4667-ad47-4afe519abb53"; // String | Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide.
+ String $include = "events"; // String | 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.
Integer $top = 56; // Integer | The number of items to include in the result.
Integer $skip = 56; // Integer | The number of items to skip in the result.
try {
- DocumentListResponse result = apiInstance.getDocumentList(avalaraVersion, xAvalaraClient, startDate, endDate, flow, $count, $countOnly, $filter, $top, $skip);
+ DocumentListResponse result = apiInstance.getDocumentList(avalaraVersion, xAvalaraClient, startDate, endDate, flow, $count, $countOnly, $filter, $include, $top, $skip);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentList");
@@ -250,14 +251,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
- **xAvalaraClient** | **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]
- **startDate** | **OffsetDateTime**| Start date of documents to return. This defaults to the previous month. | [optional]
- **endDate** | **OffsetDateTime**| End date of documents to return. This defaults to the current date. | [optional]
- **flow** | **String**| Optionally filter by document direction, where issued = `out` and received = `in` | [optional]
- **$count** | **String**| When set to true, the count of the collection is also returned in the response body | [optional]
- **$countOnly** | **String**| When set to true, only the count of the collection is returned | [optional]
- **$filter** | **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. | [optional]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **startDate** | **OffsetDateTime**| Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\". | [optional]
+ **endDate** | **OffsetDateTime**| End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\". | [optional]
+ **flow** | **String**| Optional filter for document direction: issued uses \"out\" and received uses \"in\". | [optional]
+ **$count** | **String**| When set to true, the response body also includes the count of items in the collection. | [optional]
+ **$countOnly** | **String**| When set to true, the response returns only the count of items in the collection. | [optional]
+ **$filter** | **String**| Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide. | [optional]
+ **$include** | **String**| 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** | **Integer**| The number of items to include in the result. | [optional]
**$skip** | **Integer**| The number of items to skip in the result. | [optional]
@@ -278,10 +280,10 @@ Name | Type | Description | Notes
### HTTP response details
| 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. | - |
## getDocumentStatus
@@ -290,7 +292,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
@@ -320,9 +322,9 @@ public class Example {
ApiClient apiClient = new ApiClient(configuration);
DocumentsApi apiInstance = new DocumentsApi(apiClient);
- String avalaraVersion = "1.4"; // String | The HTTP Header meant to specify the version of the API intended to be used
- String documentId = "documentId_example"; // String | The unique ID for this document that was returned in the POST /einvoicing/documents response body
- String xAvalaraClient = "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.
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String documentId = "documentId_example"; // String | The unique documentId returned in the POST /documents response body.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
try {
DocumentStatusResponse result = apiInstance.getDocumentStatus(avalaraVersion, documentId, xAvalaraClient);
System.out.println(result);
@@ -342,9 +344,9 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
- **documentId** | **String**| The unique ID for this document that was returned in the POST /einvoicing/documents response body |
- **xAvalaraClient** | **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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **documentId** | **String**| The unique documentId returned in the POST /documents response body. |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
### Return type
@@ -363,9 +365,9 @@ Name | Type | Description | Notes
### HTTP response details
| 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. | - |
@@ -405,10 +407,10 @@ public class Example {
ApiClient apiClient = new ApiClient(configuration);
DocumentsApi apiInstance = new DocumentsApi(apiClient);
- String avalaraVersion = "1.4"; // String | The HTTP Header meant to specify the version of the API intended to be used
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
SubmitDocumentMetadata metadata = new SubmitDocumentMetadata(); // SubmitDocumentMetadata |
Object data = null; // Object | The document to be submitted, as indicated by the metadata fields 'dataFormat' and 'dataFormatVersion'
- String xAvalaraClient = "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.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
try {
DocumentSubmitResponse result = apiInstance.submitDocument(avalaraVersion, metadata, data, xAvalaraClient);
System.out.println(result);
@@ -428,10 +430,10 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
+ **avalaraVersion** | **String**| 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' |
- **xAvalaraClient** | **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]
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
### Return type
@@ -450,8 +452,8 @@ Name | Type | Description | Notes
### HTTP response details
| 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. | - |
diff --git a/docs/EInvoicing/V1/Identifier.md b/docs/EInvoicing/V1/Identifier.md
index 0c4cfdc..a273552 100644
--- a/docs/EInvoicing/V1/Identifier.md
+++ b/docs/EInvoicing/V1/Identifier.md
@@ -10,6 +10,7 @@
|**name** | **String** | Identifier name (e.g., Peppol Participant ID). | |
|**displayName** | **String** | Display name of the identifier. | [optional] |
|**value** | **String** | Value of the identifier. | |
+|**extensions** | [**List<Extension>**](Extension.md) | Optional array used to carry additional metadata or configuration values for the identifier. | [optional] |
diff --git a/docs/EInvoicing/V1/InteropApi.md b/docs/EInvoicing/V1/InteropApi.md
index 7a01b68..a3be0a9 100644
--- a/docs/EInvoicing/V1/InteropApi.md
+++ b/docs/EInvoicing/V1/InteropApi.md
@@ -14,7 +14,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
@@ -46,9 +46,9 @@ public class Example {
InteropApi apiInstance = new InteropApi(apiClient);
String documentType = "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.
String interchangeType = "FI-B2B-TIEKE"; // 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.
- String avalaraVersion = "1.4"; // String | The HTTP Header meant to specify the version of the API intended to be used
- String xAvalaraClient = "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\"
- String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | The caller can use this as an identifier to use as a correlation id to trace the call.
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
File fileName = new File("/path/to/file"); // File | The file to be uploaded (e.g., UBL XML, CII XML).
try {
SubmitInteropDocument202Response result = apiInstance.submitInteropDocument(documentType, interchangeType, avalaraVersion, xAvalaraClient, xCorrelationID, fileName);
@@ -71,9 +71,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**documentType** | **String**| Type of the document being uploaded. Partners will be configured in Avalara system to send only certain types of documents. | [enum: ubl-invoice-2.1, ubl-creditnote-2.1, ubl-applicationresponse-2.1]
**interchangeType** | **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. | [enum: FI-B2B-TIEKE, FI-B2G-TIEKE]
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
- **xAvalaraClient** | **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]
- **xCorrelationID** | **String**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **xCorrelationID** | **String**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional]
**fileName** | **File**| The file to be uploaded (e.g., UBL XML, CII XML). | [optional]
### Return type
@@ -93,9 +93,9 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **202** | Document Accepted. This doesn't mean it is processed. This is just a transport ack. | * X-Correlation-ID - 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.
Integer $top = 56; // Integer | The number of items to include in the result.
Integer $skip = 56; // Integer | The number of items to skip in the result.
Boolean $count = true; // Boolean | When set to true, the count of the collection is also returned in the response body.
- Boolean $countOnly = true; // Boolean | When set to true, only the count of the collection is returned
+ Boolean $countOnly = true; // Boolean | When set to true, only the count of the collection is returned.
try {
MandatesResponse result = apiInstance.getMandates(avalaraVersion, xAvalaraClient, $filter, $top, $skip, $count, $countOnly);
System.out.println(result);
@@ -162,13 +162,13 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used |
- **xAvalaraClient** | **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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
**$filter** | **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. | [optional]
**$top** | **Integer**| The number of items to include in the result. | [optional]
**$skip** | **Integer**| The number of items to skip in the result. | [optional]
**$count** | **Boolean**| When set to true, the count of the collection is also returned in the response body. | [optional]
- **$countOnly** | **Boolean**| When set to true, only the count of the collection is returned | [optional]
+ **$countOnly** | **Boolean**| When set to true, only the count of the collection is returned. | [optional]
### Return type
@@ -187,9 +187,9 @@ Name | Type | Description | Notes
### HTTP response details
| 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. | - |
diff --git a/docs/EInvoicing/V1/ReportDownloadResponse.md b/docs/EInvoicing/V1/ReportDownloadResponse.md
new file mode 100644
index 0000000..933d977
--- /dev/null
+++ b/docs/EInvoicing/V1/ReportDownloadResponse.md
@@ -0,0 +1,15 @@
+
+
+# ReportDownloadResponse
+
+Returns a pre-signed URL to download the report file.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**reportId** | **String** | The unique identifier of the report. | [optional] |
+|**downloadUrl** | **URI** | A pre-signed URL to download the report file. This URL is time-limited. | [optional] |
+
+
+
diff --git a/docs/EInvoicing/V1/ReportItem.md b/docs/EInvoicing/V1/ReportItem.md
new file mode 100644
index 0000000..5de0c1b
--- /dev/null
+++ b/docs/EInvoicing/V1/ReportItem.md
@@ -0,0 +1,32 @@
+
+
+# ReportItem
+
+Represents a single report with full details including metadata and associated transaction IDs.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**reportId** | **String** | The unique ID for this report. | [optional] |
+|**jobId** | **String** | The unique ID of the job that generated this report. | [optional] |
+|**reportGenerateDate** | **OffsetDateTime** | The date and time when the report was generated. | [optional] |
+|**reportFrom** | **LocalDate** | The start date of the reporting period. | [optional] |
+|**reportTo** | **LocalDate** | The end date of the reporting period. | [optional] |
+|**countryCode** | **String** | The two-letter ISO-3166 country code for which this report was generated. | [optional] |
+|**countryMandate** | **String** | The e-invoicing mandate for the specified country. | [optional] |
+|**documentType** | **String** | The type of document covered by this report. | [optional] |
+|**documentSubType** | **String** | The sub-type of the document. | [optional] |
+|**reportReference** | **String** | An internal reference path for the report. | [optional] |
+|**reportName** | **String** | The name of the report file. | [optional] |
+|**status** | **String** | The current status of the report. Possible values include: PENDING, PROCESSING, COMPLETED, FAILED, SENT_TO_PPF, ERROR. | [optional] |
+|**reportFormatMimetypes** | **String** | The MIME type of the report file. | [optional] |
+|**tenantId** | **String** | The tenant identifier associated with this report. | [optional] |
+|**taName** | **String** | The name of the tax authority for this report. | [optional] |
+|**taxInvoiceAmount** | **BigDecimal** | The total invoice amount covered by this report. | [optional] |
+|**totalTaxAmount** | **BigDecimal** | The total tax amount covered by this report. | [optional] |
+|**metadata** | **Object** | Additional report metadata (free-form JSON). Contents vary by country mandate. | [optional] |
+|**transactionIds** | **List<String>** | List of transaction IDs associated with this report. | [optional] |
+
+
+
diff --git a/docs/EInvoicing/V1/ReportListResponse.md b/docs/EInvoicing/V1/ReportListResponse.md
new file mode 100644
index 0000000..34b78f0
--- /dev/null
+++ b/docs/EInvoicing/V1/ReportListResponse.md
@@ -0,0 +1,16 @@
+
+
+# ReportListResponse
+
+Returns the requested list of reports matching the query parameters.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**atRecordsetCount** | **String** | Count of reports matching the filter for the given query. Present when the request includes $count=true. | [optional] |
+|**atNextLink** | **String** | 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. | |
+
+
+
diff --git a/docs/EInvoicing/V1/ReportsApi.md b/docs/EInvoicing/V1/ReportsApi.md
new file mode 100644
index 0000000..3a795be
--- /dev/null
+++ b/docs/EInvoicing/V1/ReportsApi.md
@@ -0,0 +1,283 @@
+# ReportsApi
+
+All URIs are relative to *https://api.sbx.avalara.com/einvoicing*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**downloadReport**](ReportsApi.md#downloadReport) | **GET** /reports/{reportId}/$download | Returns a pre-signed download URL for a report
+[**getReportById**](ReportsApi.md#getReportById) | **GET** /reports/{reportId}/status | Retrieves a report by its unique ID
+[**getReports**](ReportsApi.md#getReports) | **GET** /reports | Returns a list of reports
+
+
+
+## downloadReport
+
+> ReportDownloadResponse downloadReport(avalaraVersion, reportId, xAvalaraClient, xCorrelationID)
+
+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
+
+```java
+// Import classes:
+import Avalara.SDK.ApiClient;
+import Avalara.SDK.ApiException;
+import Avalara.SDK.Configuration;
+import Avalara.SDK.auth.*;
+import Avalara.SDK.models.*;
+import Avalara.SDK.api.EInvoicing.V1.ReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ Configuration configuration = new Configuration();
+ configuration.setAppName("Test");
+ configuration.setAppVersion("1.0");
+ configuration.setMachineName("LocalBox");
+ configuration.setTimeout(5000);
+ configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
+ // Configure HTTP basic authorization
+ configuration.setUsername("YOUR USERNAME");
+ configuration.setPassword("YOUR PASSWORD");
+ // Configure OAuth2 access token for authorization
+ configuration.setBearerToken("YOUR ACCESS TOKEN");
+
+ ApiClient apiClient = new ApiClient(configuration);
+
+ ReportsApi apiInstance = new ReportsApi(apiClient);
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String reportId = "reportId_example"; // String | The unique ID for this report as returned in a GET /reports response.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
+ try {
+ ReportDownloadResponse result = apiInstance.downloadReport(avalaraVersion, reportId, xAvalaraClient, xCorrelationID);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ReportsApi#downloadReport");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **reportId** | **String**| The unique ID for this report as returned in a GET /reports response. |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **xCorrelationID** | **String**| 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. | - |
+
+
+## getReportById
+
+> ReportItem getReportById(avalaraVersion, reportId, xAvalaraClient, xCorrelationID)
+
+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
+
+```java
+// Import classes:
+import Avalara.SDK.ApiClient;
+import Avalara.SDK.ApiException;
+import Avalara.SDK.Configuration;
+import Avalara.SDK.auth.*;
+import Avalara.SDK.models.*;
+import Avalara.SDK.api.EInvoicing.V1.ReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ Configuration configuration = new Configuration();
+ configuration.setAppName("Test");
+ configuration.setAppVersion("1.0");
+ configuration.setMachineName("LocalBox");
+ configuration.setTimeout(5000);
+ configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
+ // Configure HTTP basic authorization
+ configuration.setUsername("YOUR USERNAME");
+ configuration.setPassword("YOUR PASSWORD");
+ // Configure OAuth2 access token for authorization
+ configuration.setBearerToken("YOUR ACCESS TOKEN");
+
+ ApiClient apiClient = new ApiClient(configuration);
+
+ ReportsApi apiInstance = new ReportsApi(apiClient);
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String reportId = "reportId_example"; // String | The unique ID for this report as returned in a GET /reports response.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
+ try {
+ ReportItem result = apiInstance.getReportById(avalaraVersion, reportId, xAvalaraClient, xCorrelationID);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ReportsApi#getReportById");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **reportId** | **String**| The unique ID for this report as returned in a GET /reports response. |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **xCorrelationID** | **String**| 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. | - |
+
+
+## getReports
+
+> ReportListResponse getReports(avalaraVersion, xAvalaraClient, xCorrelationID, $filter, $top, $skip, $count, $countOnly, $orderby)
+
+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
+
+```java
+// Import classes:
+import Avalara.SDK.ApiClient;
+import Avalara.SDK.ApiException;
+import Avalara.SDK.Configuration;
+import Avalara.SDK.auth.*;
+import Avalara.SDK.models.*;
+import Avalara.SDK.api.EInvoicing.V1.ReportsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ Configuration configuration = new Configuration();
+ configuration.setAppName("Test");
+ configuration.setAppVersion("1.0");
+ configuration.setMachineName("LocalBox");
+ configuration.setTimeout(5000);
+ configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
+ // Configure HTTP basic authorization
+ configuration.setUsername("YOUR USERNAME");
+ configuration.setPassword("YOUR PASSWORD");
+ // Configure OAuth2 access token for authorization
+ configuration.setBearerToken("YOUR ACCESS TOKEN");
+
+ ApiClient apiClient = new ApiClient(configuration);
+
+ ReportsApi apiInstance = new ReportsApi(apiClient);
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
+ String $filter = "status eq 'COMPLETED'"; // String | 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'
+ Integer $top = 56; // Integer | The number of items to include in the result.
+ Integer $skip = 56; // Integer | The number of items to skip in the result.
+ String $count = "true"; // String | When set to true, the response body also includes the count of items in the collection.
+ String $countOnly = "false"; // String | When set to true, the response returns only the count of items in the collection.
+ String $orderby = "reportGenerateDate desc"; // String | OData-style orderby expression. Format: 'field asc' or 'field desc'. Default: reportGenerateDate desc
+ try {
+ ReportListResponse result = apiInstance.getReports(avalaraVersion, xAvalaraClient, xCorrelationID, $filter, $top, $skip, $count, $countOnly, $orderby);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling ReportsApi#getReports");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **xCorrelationID** | **String**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional]
+ **$filter** | **String**| 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** | **Integer**| The number of items to include in the result. | [optional]
+ **$skip** | **Integer**| The number of items to skip in the result. | [optional]
+ **$count** | **String**| When set to true, the response body also includes the count of items in the collection. | [optional]
+ **$countOnly** | **String**| When set to true, the response returns only the count of items in the collection. | [optional]
+ **$orderby** | **String**| OData-style orderby expression. Format: 'field asc' or 'field desc'. Default: reportGenerateDate desc | [optional] [default to 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. | - |
+
diff --git a/docs/EInvoicing/V1/StatusEvent.md b/docs/EInvoicing/V1/StatusEvent.md
index c22217e..261e4f0 100644
--- a/docs/EInvoicing/V1/StatusEvent.md
+++ b/docs/EInvoicing/V1/StatusEvent.md
@@ -8,10 +8,11 @@ Displays when a status event occurred
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
-|**eventDateTime** | **String** | The date and time when the status event occured, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] |
+|**eventDateTime** | **String** | The date and time when the status event occurred, displayed in the format YYYY-MM-DDThh:mm:ss | [optional] |
|**message** | **String** | A message describing the status event | [optional] |
|**responseKey** | **String** | 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] |
|**responseValue** | **String** | The corresponding value associated with the response key. This value is provided by the tax authority in response to the event. | [optional] |
+|**category** | **String** | 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] |
diff --git a/docs/EInvoicing/V1/SubscriptionsApi.md b/docs/EInvoicing/V1/SubscriptionsApi.md
index c3994b1..384ec14 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
------------- | ------------- | -------------
[**createWebhookSubscription**](SubscriptionsApi.md#createWebhookSubscription) | **POST** /webhooks/subscriptions | Create a subscription to events
-[**deleteWebhookSubscription**](SubscriptionsApi.md#deleteWebhookSubscription) | **DELETE** /webhooks/subscriptions/{subscription-id} | Unsubscribe from events
-[**getWebhookSubscription**](SubscriptionsApi.md#getWebhookSubscription) | **GET** /webhooks/subscriptions/{subscription-id} | Get details of a subscription
+[**deleteWebhookSubscription**](SubscriptionsApi.md#deleteWebhookSubscription) | **DELETE** /webhooks/subscriptions/{subscriptionId} | Unsubscribe from events
+[**getWebhookSubscription**](SubscriptionsApi.md#getWebhookSubscription) | **GET** /webhooks/subscriptions/{subscriptionId} | Get details of a subscription
[**listWebhookSubscriptions**](SubscriptionsApi.md#listWebhookSubscriptions) | **GET** /webhooks/subscriptions | List all subscriptions
@@ -17,7 +17,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
@@ -47,7 +47,7 @@ public class Example {
ApiClient apiClient = new ApiClient(configuration);
SubscriptionsApi apiInstance = new SubscriptionsApi(apiClient);
- String avalaraVersion = "avalaraVersion_example"; // String | The version of the API to use, e.g., \"1.4\".
+ String avalaraVersion = "avalaraVersion_example"; // String | The version of the API to use, e.g., \"1.6\".
SubscriptionRegistration subscriptionRegistration = new SubscriptionRegistration(); // SubscriptionRegistration |
String xCorrelationID = "xCorrelationID_example"; // String | A unique identifier for tracking the request and its response
String xAvalaraClient = "xAvalaraClient_example"; // String | Client application identification
@@ -70,7 +70,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The version of the API to use, e.g., \"1.4\". |
+ **avalaraVersion** | **String**| The version of the API to use, e.g., \"1.6\". |
**subscriptionRegistration** | [**SubscriptionRegistration**](SubscriptionRegistration.md)| |
**xCorrelationID** | **String**| A unique identifier for tracking the request and its response | [optional]
**xAvalaraClient** | **String**| Client application identification | [optional]
@@ -92,10 +92,10 @@ Name | Type | Description | Notes
### HTTP response details
| 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 eq operator and the name field is supported. For more information, refer to [AvaTax filtering guide](https://developer.avalara.com/avatax/filtering-in-rest/).
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ String $filter = "name eq 'Batch_Search_Import_V4'"; // String | 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.
Boolean count = true; // Boolean | When set to true, returns the total count of matching records included as @recordSetCount in the response body.
Integer $top = 56; // Integer | The number of items to include in the result.
Integer $skip = 56; // Integer | The number of items to skip in the result.
String $orderBy = "name desc"; // String | 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.
- String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | The caller can use this as an identifier to use as a correlation id to trace the call.
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
try {
BatchSearchListResponse result = apiInstance.listBatchSearches(avalaraVersion, xAvalaraClient, $filter, count, $top, $skip, $orderBy, xCorrelationID);
System.out.println(result);
@@ -613,14 +613,14 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used. |
- **xAvalaraClient** | **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**| 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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **$filter** | **String**| 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** | **Boolean**| When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional]
**$top** | **Integer**| The number of items to include in the result. | [optional]
**$skip** | **Integer**| The number of items to skip in the result. | [optional]
**$orderBy** | **String**| 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]
- **xCorrelationID** | **String**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional]
+ **xCorrelationID** | **String**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional]
### Return type
@@ -639,11 +639,11 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | List of batch searches | * X-Correlation-Id - 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).
- String xAvalaraClient = "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\".
- Boolean count = true; // Boolean | When set to true, returns the total count of matching records included as @recordSetCount in the response body.
- String $filter = "network eq 'Peppol' and country eq 'Australia'"; // String | 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/).
+ String avalaraVersion = "1.6"; // String | Header that specifies the API version to use (for example \"1.6\").
+ String $search = "Acme AND 7726627177 OR BMW"; // String | 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.
+ String xAvalaraClient = "John's E-Invoicing-API Client"; // String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
+ Boolean count = true; // Boolean | When set to true, returns the total count of matching records included as @recordSetCount in the response body.
+ String $filter = "network eq 'Peppol' and country eq 'Australia'"; // String | Filters the results using the eq operator. Supported fields include network, country, documentType, and idType. For more information, refer to the Avalara filtering guide.
Integer $top = 56; // Integer | The number of items to include in the result.
Integer $skip = 56; // Integer | The number of items to skip in the result.
- String $orderBy = "name desc"; // String | 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.
- String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | The caller can use this as an identifier to use as a correlation id to trace the call.
+ String $orderBy = "name desc"; // String | 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.
+ String xCorrelationID = "f3f0d19a-01a1-4748-8a58-f000d0424f43"; // String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
try {
SearchParticipants200Response result = apiInstance.searchParticipants(avalaraVersion, $search, xAvalaraClient, count, $filter, $top, $skip, $orderBy, xCorrelationID);
System.out.println(result);
@@ -710,15 +710,15 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **avalaraVersion** | **String**| The HTTP Header meant to specify the version of the API intended to be used. |
- **$search** | **String**| 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). |
- **xAvalaraClient** | **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]
- **count** | **Boolean**| When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional]
- **$filter** | **String**| 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]
+ **avalaraVersion** | **String**| Header that specifies the API version to use (for example \"1.6\"). |
+ **$search** | **String**| 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. |
+ **xAvalaraClient** | **String**| Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). | [optional]
+ **count** | **Boolean**| When set to true, returns the total count of matching records included as @recordSetCount in the response body. | [optional]
+ **$filter** | **String**| 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** | **Integer**| The number of items to include in the result. | [optional]
**$skip** | **Integer**| The number of items to skip in the result. | [optional]
- **$orderBy** | **String**| 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]
- **xCorrelationID** | **String**| The caller can use this as an identifier to use as a correlation id to trace the call. | [optional]
+ **$orderBy** | **String**| 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]
+ **xCorrelationID** | **String**| Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). | [optional]
### Return type
@@ -737,11 +737,11 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | OK | * X-Correlation-Id - | Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Code list not found. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Code list not found. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Code list not found. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Code list not found. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
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)
+ * @param avalaraVersion Header that specifies the API version to use (for example \"1.6\").
+ * @param xAvalaraClient Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
+ * @param $filter Filter by field name and value. This filter supports only eq and contains. For more information, refer to the Avalara filtering guide. (optional)
* @param $top The number of items to include in the result. (optional)
* @param $skip The number of items to skip in the result. (optional)
- * @param $count When set to true, the count of the collection is also returned in the response body (optional)
- * @param $countOnly When set to true, only the count of the collection is returned (optional)
+ * @param $count When set to true, the response body also includes the count of items in the collection. (optional)
+ * @param $countOnly When set to true, the response returns only the count of items in the collection. (optional)
*/
public class GetDataInputFieldsRequest {
private String avalaraVersion;
@@ -268,7 +268,7 @@ public class GetDataInputFieldsRequest {
public GetDataInputFieldsRequest () {
}
- public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.4"; }
+ public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.6"; }
public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; }
public String getXAvalaraClient() { return xAvalaraClient; }
public void setXAvalaraClient(String xAvalaraClient) { this.xAvalaraClient = xAvalaraClient; }
@@ -294,7 +294,7 @@ public GetDataInputFieldsRequest getGetDataInputFieldsRequest() {
private void SetConfiguration(ApiClient client) {
if (client == null) throw new MissingFormatArgumentException("client");
- this.localVarApiClient.setSdkVersion("25.11.2");
+ this.localVarApiClient.setSdkVersion("26.4.0");
}
}
diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java
index 6cd3511..084d537 100644
--- a/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java
+++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/DocumentsApi.java
@@ -96,11 +96,11 @@ public void setCustomBaseUrl(String customBaseUrl) {
* @http.response.details
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
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)
+ * @param avalaraVersion Header that specifies the API version to use (for example \"1.6\").
+ * @param xAvalaraClient Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
+ * @param startDate Start date for documents to return. Defaults to the previous month. Format: \"YYYY-MM-DDThh:mm:ss\". (optional)
+ * @param endDate End date for documents to return. Defaults to the current date. Format: \"YYYY-MM-DDThh:mm:ss\". (optional)
+ * @param flow Optional filter for document direction: issued uses \"out\" and received uses \"in\". (optional)
+ * @param $count When set to true, the response body also includes the count of items in the collection. (optional)
+ * @param $countOnly When set to true, the response returns only the count of items in the collection. (optional)
+ * @param $filter Filter by field name and value. This filter supports only eq. For more information, refer to the Avalara filtering guide. (optional)
+ * @param $include 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)
* @param $top The number of items to include in the result. (optional)
* @param $skip The number of items to skip in the result. (optional)
*/
@@ -679,13 +684,14 @@ public class GetDocumentListRequest {
private String $count;
private String $countOnly;
private String $filter;
+ private String $include;
private Integer $top;
private Integer $skip;
public GetDocumentListRequest () {
}
- public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.4"; }
+ public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.6"; }
public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; }
public String getXAvalaraClient() { return xAvalaraClient; }
public void setXAvalaraClient(String xAvalaraClient) { this.xAvalaraClient = xAvalaraClient; }
@@ -701,6 +707,8 @@ public GetDocumentListRequest () {
public void set$countOnly(String $countOnly) { this.$countOnly = $countOnly; }
public String get$filter() { return $filter; }
public void set$filter(String $filter) { this.$filter = $filter; }
+ public String get$include() { return $include; }
+ public void set$include(String $include) { this.$include = $include; }
public Integer get$top() { return $top; }
public void set$top(Integer $top) { this.$top = $top; }
public Integer get$skip() { return $skip; }
@@ -724,9 +732,9 @@ public GetDocumentListRequest getGetDocumentListRequest() {
* @http.response.details
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 | - |
| 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 | - |
| 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 | - |
| 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 | - |
| 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
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)
* @param $top The number of items to include in the result. (optional)
* @param $skip The number of items to skip in the result. (optional)
* @param $count When set to true, the count of the collection is also returned in the response body. (optional)
- * @param $countOnly When set to true, only the count of the collection is returned (optional)
+ * @param $countOnly When set to true, only the count of the collection is returned. (optional)
*/
public class GetMandatesRequest {
private String avalaraVersion;
@@ -495,7 +495,7 @@ public class GetMandatesRequest {
public GetMandatesRequest () {
}
- public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.4"; }
+ public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.6"; }
public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; }
public String getXAvalaraClient() { return xAvalaraClient; }
public void setXAvalaraClient(String xAvalaraClient) { this.xAvalaraClient = xAvalaraClient; }
@@ -521,7 +521,7 @@ public GetMandatesRequest getGetMandatesRequest() {
private void SetConfiguration(ApiClient client) {
if (client == null) throw new MissingFormatArgumentException("client");
- this.localVarApiClient.setSdkVersion("25.11.2");
+ this.localVarApiClient.setSdkVersion("26.4.0");
}
}
diff --git a/src/main/java/Avalara/SDK/api/EInvoicing/V1/ReportsApi.java b/src/main/java/Avalara/SDK/api/EInvoicing/V1/ReportsApi.java
new file mode 100644
index 0000000..97a0b32
--- /dev/null
+++ b/src/main/java/Avalara/SDK/api/EInvoicing/V1/ReportsApi.java
@@ -0,0 +1,711 @@
+/*
+ * AvaTax Software Development Kit for Java (JRE)
+ *
+ * (c) 2004-2025 Avalara, Inc.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Avalara E-Invoicing API
+ *
+ * An API that supports sending data for an E-Invoicing compliance use-case.
+ *
+ * @author Sachin Baijal | 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. | - |
| 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. | - |
| 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. | - |
| 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. | - |
| Status Code | Description | Response Headers |
| 200 | Report found and returned successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Report not found. | - |
| Status Code | Description | Response Headers |
| 200 | Report found and returned successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Report not found. | - |
| Status Code | Description | Response Headers |
| 200 | Report found and returned successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Report not found. | - |
| Status Code | Description | Response Headers |
| 200 | Report found and returned successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 404 | Report not found. | - |
| Status Code | Description | Response Headers |
| 200 | Reports retrieved successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | Reports retrieved successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | Reports retrieved successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| Status Code | Description | Response Headers |
| 200 | Reports retrieved successfully. | - |
| 400 | Bad request. | - |
| 401 | Unauthorized. | - |
| 403 | Forbidden. | - |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
| 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 - |
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)
+ * @param avalaraVersion Header that specifies the API version to use (for example \"1.6\").
+ * @param xAvalaraClient Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
+ * @param $filter 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)
* @param count When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional)
* @param $top The number of items to include in the result. (optional)
* @param $skip The number of items to skip in the result. (optional)
* @param $orderBy 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)
- * @param xCorrelationID The caller can use this as an identifier to use as a correlation id to trace the call. (optional)
+ * @param xCorrelationID Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
*/
public class ListBatchSearchesRequest {
private String avalaraVersion;
@@ -1509,7 +1509,7 @@ public class ListBatchSearchesRequest {
public ListBatchSearchesRequest () {
}
- public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.4"; }
+ public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.6"; }
public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; }
public String getXAvalaraClient() { return xAvalaraClient; }
public void setXAvalaraClient(String xAvalaraClient) { this.xAvalaraClient = xAvalaraClient; }
@@ -1544,11 +1544,11 @@ public ListBatchSearchesRequest getListBatchSearchesRequest() {
* @http.response.details
| 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 - |
| 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 - |
| 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 - |
| 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 - |
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).
- * @param xAvalaraClient 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)
- * @param count When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional)
- * @param $filter 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)
+ * @param avalaraVersion Header that specifies the API version to use (for example \"1.6\").
+ * @param $search 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.
+ * @param xAvalaraClient Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
+ * @param count When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional)
+ * @param $filter 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)
* @param $top The number of items to include in the result. (optional)
* @param $skip The number of items to skip in the result. (optional)
- * @param $orderBy 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)
- * @param xCorrelationID The caller can use this as an identifier to use as a correlation id to trace the call. (optional)
+ * @param $orderBy 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)
+ * @param xCorrelationID Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
*/
public class SearchParticipantsRequest {
private String avalaraVersion;
@@ -1748,7 +1748,7 @@ public class SearchParticipantsRequest {
public SearchParticipantsRequest () {
}
- public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.4"; }
+ public String getAvalaraVersion() { return (avalaraVersion != null) ? avalaraVersion : "1.6"; }
public void setAvalaraVersion(String avalaraVersion) { this.avalaraVersion = avalaraVersion; }
public String get$search() { return $search; }
public void set$search(String $search) { this.$search = $search; }
@@ -1786,12 +1786,12 @@ public SearchParticipantsRequest getSearchParticipantsRequest() {
| 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 - |
| 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 - |
| 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 - |
| 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 - |