Skip to content

Commit

Permalink
Merge pull request #1 from avadev/release/24.12.10
Browse files Browse the repository at this point in the history
Release/24.12.10
  • Loading branch information
svc-developer authored Jan 3, 2025
2 parents 7f1b285 + 28ed073 commit 3f7fd5a
Show file tree
Hide file tree
Showing 91 changed files with 9,729 additions and 1,010 deletions.
2 changes: 1 addition & 1 deletion .bsp/sbt.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"name":"sbt","version":"1.5.8","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["C:\\Program Files\\Java\\jdk-17.0.1/bin/java","-Xms100m","-Xmx100m","-classpath","C:/Users/jonathan.wenger/AppData/Roaming/JetBrains/IdeaIC2021.3/plugins/Scala/launcher/sbt-launch.jar","xsbt.boot.Boot","-bsp","--sbt-launch-jar=C:/Users/jonathan.wenger/AppData/Roaming/JetBrains/IdeaIC2021.3/plugins/Scala/launcher/sbt-launch.jar"]}
{"name":"sbt","version":"1.5.8","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["C:\\Users\\jonathan.wenger\\.jdks\\corretto-17.0.11/bin/java","-Xms100m","-Xmx100m","-classpath","C:/Users/jonathan.wenger/AppData/Roaming/JetBrains/IdeaIC2021.3/plugins/Scala/launcher/sbt-launch.jar","xsbt.boot.Boot","-bsp","--sbt-launch-jar=C:/Users/jonathan.wenger/AppData/Roaming/JetBrains/IdeaIC2021.3/plugins/Scala/launcher/sbt-launch.jar"]}
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,20 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DataInputFieldsApi* | [**getDataInputFields**](docs/EInvoicing/V1/DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
*DataInputFieldsApi* | [**getDataInputFields**](docs/EInvoicing/V1/DataInputFieldsApi.md#getdatainputfields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates
*DocumentsApi* | [**downloadDocument**](docs/EInvoicing/V1/DocumentsApi.md#downloaddocument) | **GET** /documents/{documentId}/$download | Returns a copy of the document
*DocumentsApi* | [**fetchDocuments**](docs/EInvoicing/V1/DocumentsApi.md#fetchdocuments) | **POST** /documents/$fetch | Fetch the inbound document from a tax authority
*DocumentsApi* | [**getDocumentList**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentlist) | **GET** /documents | Returns a summary of documents for a date range
*DocumentsApi* | [**getDocumentStatus**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentstatus) | **GET** /document/{documentId}/status | Checks the status of a document
*DocumentsApi* | [**getDocumentStatus**](docs/EInvoicing/V1/DocumentsApi.md#getdocumentstatus) | **GET** /documents/{documentId}/status | Checks the status of a document
*DocumentsApi* | [**submitDocument**](docs/EInvoicing/V1/DocumentsApi.md#submitdocument) | **POST** /documents | Submits a document to Avalara E-Invoicing API
*InteropApi* | [**submitInteropDocument**](docs/EInvoicing/V1/InteropApi.md#submitinteropdocument) | **POST** /interop/documents | Submit a document
*MandatesApi* | [**getMandateDataInputFields**](docs/EInvoicing/V1/MandatesApi.md#getmandatedatainputfields) | **GET** /mandates/{mandateId}/data-input-fields | Returns document field information for a country mandate, a selected document type, and its version
*MandatesApi* | [**getMandates**](docs/EInvoicing/V1/MandatesApi.md#getmandates) | **GET** /mandates | List country mandates that are supported by the Avalara E-Invoicing platform
*TradingPartnersApi* | [**batchSearchParticipants**](docs/EInvoicing/V1/TradingPartnersApi.md#batchsearchparticipants) | **POST** /trading-partners/batch-searches | Creates a batch search and performs a batch search in the directory for participants in the background.
*TradingPartnersApi* | [**downloadBatchSearchReport**](docs/EInvoicing/V1/TradingPartnersApi.md#downloadbatchsearchreport) | **GET** /trading-partners/batch-searches/{id}/$download-results | Download batch search results in a csv file.
*TradingPartnersApi* | [**getBatchSearchDetail**](docs/EInvoicing/V1/TradingPartnersApi.md#getbatchsearchdetail) | **GET** /trading-partners/batch-searches/{id} | Get the batch search details for a given id.
*TradingPartnersApi* | [**listBatchSearches**](docs/EInvoicing/V1/TradingPartnersApi.md#listbatchsearches) | **GET** /trading-partners/batch-searches | List all batch searches that were previously submitted.
*TradingPartnersApi* | [**searchParticipants**](docs/EInvoicing/V1/TradingPartnersApi.md#searchparticipants) | **GET** /trading-partners | Returns a list of participants matching the input query.

<a name="documentation-for-models"></a>
## Documentation for Models
Expand All @@ -249,26 +257,40 @@ Class | Method | HTTP request | Description

- [Avalara.SDK.model.EInvoicing.V1.BadDownloadRequest](docs/EInvoicing/V1/BadDownloadRequest.md)
- [Avalara.SDK.model.EInvoicing.V1.BadRequest](docs/EInvoicing/V1/BadRequest.md)
- [Avalara.SDK.model.EInvoicing.V1.BatchSearch](docs/EInvoicing/V1/BatchSearch.md)
- [Avalara.SDK.model.EInvoicing.V1.BatchSearchListResponse](docs/EInvoicing/V1/BatchSearchListResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.ConditionalForField](docs/EInvoicing/V1/ConditionalForField.md)
- [Avalara.SDK.model.EInvoicing.V1.DataInputField](docs/EInvoicing/V1/DataInputField.md)
- [Avalara.SDK.model.EInvoicing.V1.DataInputFieldNotUsedFor](docs/EInvoicing/V1/DataInputFieldNotUsedFor.md)
- [Avalara.SDK.model.EInvoicing.V1.DataInputFieldOptionalFor](docs/EInvoicing/V1/DataInputFieldOptionalFor.md)
- [Avalara.SDK.model.EInvoicing.V1.DataInputFieldRequiredFor](docs/EInvoicing/V1/DataInputFieldRequiredFor.md)
- [Avalara.SDK.model.EInvoicing.V1.DataInputFieldsResponse](docs/EInvoicing/V1/DataInputFieldsResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.DirectorySearchResponse](docs/EInvoicing/V1/DirectorySearchResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.DirectorySearchResponseValueInner](docs/EInvoicing/V1/DirectorySearchResponseValueInner.md)
- [Avalara.SDK.model.EInvoicing.V1.DirectorySearchResponseValueInnerAddressesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md)
- [Avalara.SDK.model.EInvoicing.V1.DirectorySearchResponseValueInnerIdentifiersInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md)
- [Avalara.SDK.model.EInvoicing.V1.DirectorySearchResponseValueInnerSupportedDocumentTypesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentFetch](docs/EInvoicing/V1/DocumentFetch.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentFetchRequest](docs/EInvoicing/V1/DocumentFetchRequest.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentFetchRequestDataInner](docs/EInvoicing/V1/DocumentFetchRequestDataInner.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentFetchRequestMetadata](docs/EInvoicing/V1/DocumentFetchRequestMetadata.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentListResponse](docs/EInvoicing/V1/DocumentListResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentStatusResponse](docs/EInvoicing/V1/DocumentStatusResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentSubmissionError](docs/EInvoicing/V1/DocumentSubmissionError.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentSubmitResponse](docs/EInvoicing/V1/DocumentSubmitResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.DocumentSummary](docs/EInvoicing/V1/DocumentSummary.md)
- [Avalara.SDK.model.EInvoicing.V1.ErrorResponse](docs/EInvoicing/V1/ErrorResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.ForbiddenError](docs/EInvoicing/V1/ForbiddenError.md)
- [Avalara.SDK.model.EInvoicing.V1.InputDataFormats](docs/EInvoicing/V1/InputDataFormats.md)
- [Avalara.SDK.model.EInvoicing.V1.InternalServerError](docs/EInvoicing/V1/InternalServerError.md)
- [Avalara.SDK.model.EInvoicing.V1.Mandate](docs/EInvoicing/V1/Mandate.md)
- [Avalara.SDK.model.EInvoicing.V1.MandateDataInputField](docs/EInvoicing/V1/MandateDataInputField.md)
- [Avalara.SDK.model.EInvoicing.V1.MandateDataInputFieldNamespace](docs/EInvoicing/V1/MandateDataInputFieldNamespace.md)
- [Avalara.SDK.model.EInvoicing.V1.MandatesResponse](docs/EInvoicing/V1/MandatesResponse.md)
- [Avalara.SDK.model.EInvoicing.V1.NotFoundError](docs/EInvoicing/V1/NotFoundError.md)
- [Avalara.SDK.model.EInvoicing.V1.NotUsedForField](docs/EInvoicing/V1/NotUsedForField.md)
- [Avalara.SDK.model.EInvoicing.V1.RequiredWhenField](docs/EInvoicing/V1/RequiredWhenField.md)
- [Avalara.SDK.model.EInvoicing.V1.StatusEvent](docs/EInvoicing/V1/StatusEvent.md)
- [Avalara.SDK.model.EInvoicing.V1.SubmitDocumentData](docs/EInvoicing/V1/SubmitDocumentData.md)
- [Avalara.SDK.model.EInvoicing.V1.SubmitDocumentMetadata](docs/EInvoicing/V1/SubmitDocumentMetadata.md)
- [Avalara.SDK.model.EInvoicing.V1.SubmitInteropDocument202Response](docs/EInvoicing/V1/SubmitInteropDocument202Response.md)
- [Avalara.SDK.model.EInvoicing.V1.WorkflowIds](docs/EInvoicing/V1/WorkflowIds.md)
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'Avalara.SDK'
version = '2.4.29'
version = '24.12.10'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "Avalara.SDK",
name := "Avalara.SDK",
version := "2.4.29",
version := "24.12.10",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
30 changes: 30 additions & 0 deletions docs/EInvoicing/V1/BatchSearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@


# BatchSearch


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | ID of the batch search | [optional] |
|**name** | **String** | Name of the batch report | [optional] |
|**createdBy** | **String** | Email of the user who created the batch search | [optional] |
|**created** | **OffsetDateTime** | Timestamp when the batch search was created | [optional] |
|**lastModified** | **OffsetDateTime** | Timestamp when the batch search was created | [optional] |
|**status** | [**StatusEnum**](#StatusEnum) | Status of the batch search | [optional] |
|**error** | [**ErrorResponse**](ErrorResponse.md) | | [optional] |



## Enum: StatusEnum

| Name | Value |
|---- | -----|
| ACCEPTED | &quot;Accepted&quot; |
| RUNNING | &quot;Running&quot; |
| COMPLETED | &quot;Completed&quot; |
| FAILED | &quot;Failed&quot; |



16 changes: 16 additions & 0 deletions docs/EInvoicing/V1/BatchSearchListResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# BatchSearchListResponse

Schema for batch search list

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**atRecordSetCount** | **Integer** | The count of records in the result set | [optional] |
|**atNextLink** | **String** | Next Link | [optional] |
|**value** | [**List&lt;BatchSearch&gt;**](BatchSearch.md) | | [optional] |



2 changes: 1 addition & 1 deletion docs/EInvoicing/V1/ConditionalForField.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Mandates for which this field is conditional
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**countryMandate** | **String** | | [optional] |
|**requiredWhen** | [**List&lt;RequiredWhenField&gt;**](RequiredWhenField.md) | Array of scenarios which describe when a particular field is conditional for a country mandate | [optional] |
|**requiredWhen** | **List&lt;RequiredWhenField&gt;** | Array of scenarios which describe when a particular field is conditional for a country mandate | [optional] |



2 changes: 1 addition & 1 deletion docs/EInvoicing/V1/DataInputField.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Data Input Field
|**fieldId** | **String** | Field ID | [optional] |
|**applicableDocumentRoots** | **List&lt;Object&gt;** | | [optional] |
|**path** | **String** | Path to this field | [optional] |
|**nameSpace** | **String** | Namespace of this field | [optional] |
|**namespace** | **String** | Namespace of this field | [optional] |
|**fieldName** | **String** | Field name | [optional] |
|**exampleOrFixedValue** | **String** | An example of the content for this field | [optional] |
|**acceptedValues** | **Object** | An object representing the acceptable values for this field | [optional] |
Expand Down
10 changes: 5 additions & 5 deletions docs/EInvoicing/V1/DataInputFieldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ All URIs are relative to *https://api.sbx.avalara.com/einvoicing*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getDataInputFields**](DataInputFieldsApi.md#getDataInputFields) | **GET** /data-input-fields | Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
[**getDataInputFields**](DataInputFieldsApi.md#getDataInputFields) | **GET** /data-input-fields | Returns the optionality of document fields for different country mandates



## getDataInputFields

> DataInputFieldsResponse getDataInputFields(avalaraVersion, xAvalaraClient, $filter, $top, $skip, $count, $countOnly)
Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
Returns the optionality of document fields for different country mandates

This endpoint provides a list of required, conditional, and optional fields for each country mandate. You can use the &lt;code&gt;mandates&lt;/code&gt; endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate

Expand Down Expand Up @@ -44,8 +44,8 @@ public class Example {
ApiClient apiClient = new ApiClient(configuration);

DataInputFieldsApi apiInstance = new DataInputFieldsApi(apiClient);
String avalaraVersion = "1.0"; // 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 avalaraVersion = "1.2"; // 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 $filter = "requiredFor/countryMandate eq AU-B2G-PEPPOL"; // String | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.
BigDecimal $top = new BigDecimal("10"); // BigDecimal | If nonzero, return no more than this number of results. Used with <code>$skip</code> to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
BigDecimal $skip = new BigDecimal("10"); // BigDecimal | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
Expand All @@ -71,7 +71,7 @@ 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 \&quot;Fingerprint\&quot; | [optional]
**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 &lt;code&gt;eq&lt;/code&gt; and &lt;code&gt;contains&lt;/code&gt;. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional]
**$top** | **BigDecimal**| If nonzero, return no more than this number of results. Used with &lt;code&gt;$skip&lt;/code&gt; to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. | [optional]
**$skip** | **BigDecimal**| If nonzero, skip this number of results before returning data. Used with &lt;code&gt;$top&lt;/code&gt; to provide pagination for large datasets. | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/EInvoicing/V1/DataInputFieldsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**atRecordSetCount** | **BigDecimal** | Total count of results | [optional] |
|**atRecordsetCount** | **BigDecimal** | Total count of results | [optional] |
|**atNextLink** | **String** | | [optional] |
|**value** | [**List&lt;DataInputField&gt;**](DataInputField.md) | Array of Data Input Fields | [optional] |
|**value** | **List&lt;DataInputField&gt;** | Array of Data Input Fields | [optional] |



16 changes: 16 additions & 0 deletions docs/EInvoicing/V1/DirectorySearchResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# DirectorySearchResponse

Response schema for directory search results

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**atRecordSetCount** | **Integer** | The count of records in the result set | [optional] |
|**atNextLink** | **String** | The next page link to get the next set of results. | [optional] |
|**value** | [**List&lt;DirectorySearchResponseValueInner&gt;**](DirectorySearchResponseValueInner.md) | | [optional] |



19 changes: 19 additions & 0 deletions docs/EInvoicing/V1/DirectorySearchResponseValueInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@


# DirectorySearchResponseValueInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | Avalara unique ID of the participant in the directory. | [optional] |
|**name** | **String** | Name of the participant (typically, the name of the business entity). | [optional] |
|**network** | **String** | The network where the participant is present. | [optional] |
|**registrationDate** | **LocalDate** | Registration date of the participant if available | [optional] |
|**identifiers** | [**List&lt;DirectorySearchResponseValueInnerIdentifiersInner&gt;**](DirectorySearchResponseValueInnerIdentifiersInner.md) | | [optional] |
|**addresses** | [**List&lt;DirectorySearchResponseValueInnerAddressesInner&gt;**](DirectorySearchResponseValueInnerAddressesInner.md) | | [optional] |
|**supportedDocumentTypes** | [**List&lt;DirectorySearchResponseValueInnerSupportedDocumentTypesInner&gt;**](DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md) | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# DirectorySearchResponseValueInnerAddressesInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**line1** | **String** | Address line 1 | [optional] |
|**line2** | **String** | Address line 2 | [optional] |
|**city** | **String** | City | [optional] |
|**state** | **String** | State | [optional] |
|**country** | **String** | Country | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# DirectorySearchResponseValueInnerIdentifiersInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | Peppol Participant ID if the participant is in Peppol network | [optional] |
|**value** | **String** | Value of the identifier | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


# DirectorySearchResponseValueInnerSupportedDocumentTypesInner


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**name** | **String** | Document type name. | [optional] |
|**value** | **String** | Document type identifier. | [optional] |
|**supportedByTradingPartner** | **Boolean** | Does trading partner support receiving this document type | [optional] |
|**supportedByAvalara** | **Boolean** | Does avalara support exchanging this document type | [optional] |



Loading

0 comments on commit 3f7fd5a

Please sign in to comment.