Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for 24.12.10 #1

Merged
merged 4 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,12 +219,20 @@ namespace Example

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 @@ -234,26 +242,40 @@ Class | Method | HTTP request | Description

- [Model.EInvoicing.V1.BadDownloadRequest](docs/EInvoicing/V1/BadDownloadRequest.md)
- [Model.EInvoicing.V1.BadRequest](docs/EInvoicing/V1/BadRequest.md)
- [Model.EInvoicing.V1.BatchSearch](docs/EInvoicing/V1/BatchSearch.md)
- [Model.EInvoicing.V1.BatchSearchListResponse](docs/EInvoicing/V1/BatchSearchListResponse.md)
- [Model.EInvoicing.V1.ConditionalForField](docs/EInvoicing/V1/ConditionalForField.md)
- [Model.EInvoicing.V1.DataInputField](docs/EInvoicing/V1/DataInputField.md)
- [Model.EInvoicing.V1.DataInputFieldNotUsedFor](docs/EInvoicing/V1/DataInputFieldNotUsedFor.md)
- [Model.EInvoicing.V1.DataInputFieldOptionalFor](docs/EInvoicing/V1/DataInputFieldOptionalFor.md)
- [Model.EInvoicing.V1.DataInputFieldRequiredFor](docs/EInvoicing/V1/DataInputFieldRequiredFor.md)
- [Model.EInvoicing.V1.DataInputFieldsResponse](docs/EInvoicing/V1/DataInputFieldsResponse.md)
- [Model.EInvoicing.V1.DirectorySearchResponse](docs/EInvoicing/V1/DirectorySearchResponse.md)
- [Model.EInvoicing.V1.DirectorySearchResponseValueInner](docs/EInvoicing/V1/DirectorySearchResponseValueInner.md)
- [Model.EInvoicing.V1.DirectorySearchResponseValueInnerAddressesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerAddressesInner.md)
- [Model.EInvoicing.V1.DirectorySearchResponseValueInnerIdentifiersInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerIdentifiersInner.md)
- [Model.EInvoicing.V1.DirectorySearchResponseValueInnerSupportedDocumentTypesInner](docs/EInvoicing/V1/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md)
- [Model.EInvoicing.V1.DocumentFetch](docs/EInvoicing/V1/DocumentFetch.md)
- [Model.EInvoicing.V1.DocumentFetchRequest](docs/EInvoicing/V1/DocumentFetchRequest.md)
- [Model.EInvoicing.V1.DocumentFetchRequestDataInner](docs/EInvoicing/V1/DocumentFetchRequestDataInner.md)
- [Model.EInvoicing.V1.DocumentFetchRequestMetadata](docs/EInvoicing/V1/DocumentFetchRequestMetadata.md)
- [Model.EInvoicing.V1.DocumentListResponse](docs/EInvoicing/V1/DocumentListResponse.md)
- [Model.EInvoicing.V1.DocumentStatusResponse](docs/EInvoicing/V1/DocumentStatusResponse.md)
- [Model.EInvoicing.V1.DocumentSubmissionError](docs/EInvoicing/V1/DocumentSubmissionError.md)
- [Model.EInvoicing.V1.DocumentSubmitResponse](docs/EInvoicing/V1/DocumentSubmitResponse.md)
- [Model.EInvoicing.V1.DocumentSummary](docs/EInvoicing/V1/DocumentSummary.md)
- [Model.EInvoicing.V1.ErrorResponse](docs/EInvoicing/V1/ErrorResponse.md)
- [Model.EInvoicing.V1.ForbiddenError](docs/EInvoicing/V1/ForbiddenError.md)
- [Model.EInvoicing.V1.InputDataFormats](docs/EInvoicing/V1/InputDataFormats.md)
- [Model.EInvoicing.V1.InternalServerError](docs/EInvoicing/V1/InternalServerError.md)
- [Model.EInvoicing.V1.Mandate](docs/EInvoicing/V1/Mandate.md)
- [Model.EInvoicing.V1.MandateDataInputField](docs/EInvoicing/V1/MandateDataInputField.md)
- [Model.EInvoicing.V1.MandateDataInputFieldNamespace](docs/EInvoicing/V1/MandateDataInputFieldNamespace.md)
- [Model.EInvoicing.V1.MandatesResponse](docs/EInvoicing/V1/MandatesResponse.md)
- [Model.EInvoicing.V1.NotFoundError](docs/EInvoicing/V1/NotFoundError.md)
- [Model.EInvoicing.V1.NotUsedForField](docs/EInvoicing/V1/NotUsedForField.md)
- [Model.EInvoicing.V1.RequiredWhenField](docs/EInvoicing/V1/RequiredWhenField.md)
- [Model.EInvoicing.V1.StatusEvent](docs/EInvoicing/V1/StatusEvent.md)
- [Model.EInvoicing.V1.SubmitDocumentData](docs/EInvoicing/V1/SubmitDocumentData.md)
- [Model.EInvoicing.V1.SubmitDocumentMetadata](docs/EInvoicing/V1/SubmitDocumentMetadata.md)
- [Model.EInvoicing.V1.SubmitInteropDocument202Response](docs/EInvoicing/V1/SubmitInteropDocument202Response.md)
- [Model.EInvoicing.V1.WorkflowIds](docs/EInvoicing/V1/WorkflowIds.md)
16 changes: 16 additions & 0 deletions docs/EInvoicing/V1/BatchSearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Avalara.SDK.Model.EInvoicing.V1.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** | **DateTime** | Timestamp when the batch search was created | [optional]
**LastModified** | **DateTime** | Timestamp when the batch search was created | [optional]
**Status** | **string** | Status of the batch search | [optional]
**Error** | [**ErrorResponse**](ErrorResponse.md) | | [optional]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

13 changes: 13 additions & 0 deletions docs/EInvoicing/V1/BatchSearchListResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Avalara.SDK.Model.EInvoicing.V1.BatchSearchListResponse
Schema for batch search list

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RecordSetCount** | **int** | The count of records in the result set | [optional]
**NextLink** | **string** | Next Link | [optional]
**Value** | [**List&lt;BatchSearch&gt;**](BatchSearch.md) | | [optional]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

2 changes: 1 addition & 1 deletion docs/EInvoicing/V1/DataInputField.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**FieldId** | **string** | Field ID | [optional]
**ApplicableDocumentRoots** | **List&lt;Object&gt;** | | [optional]
**Path** | **string** | Path to this field | [optional]
**VarNameSpace** | **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
12 changes: 6 additions & 6 deletions docs/EInvoicing/V1/DataInputFieldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ 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


<a name="getdatainputfields"></a>
# **GetDataInputFields**
> DataInputFieldsResponse GetDataInputFields (GetDataInputFieldsRequest requestParameters)

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 <code>mandates</code> endpoint to retrieve all available country mandates. You can use the $filter query parameter to retrieve fields for a particular mandate

Expand All @@ -38,8 +38,8 @@ namespace Example

var apiInstance = new DataInputFieldsApi(apiClient);
var requestParameters = new GetDataInputFieldsRequest();
requestParameters.AvalaraVersion = 1.0; // string | The HTTP Header meant to specify the version of the API intended to be used
requestParameters.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\" (optional)
requestParameters.AvalaraVersion = 1.2; // string | The HTTP Header meant to specify the version of the API intended to be used
requestParameters.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. (optional)
requestParameters.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. (optional)
requestParameters.Top = 10; // decimal? | 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. (optional)
requestParameters.Skip = 10; // decimal? | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. (optional)
Expand All @@ -48,7 +48,7 @@ namespace Example

try
{
// Returns the mandatory and conditional invoice or creditnote input fields for different country mandates
// Returns the optionality of document fields for different country mandates
DataInputFieldsResponse result = apiInstance.GetDataInputFields(requestParameters);
Debug.WriteLine(result);
}
Expand All @@ -68,7 +68,7 @@ namespace 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** | **decimal?**| 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** | **decimal?**| 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
2 changes: 1 addition & 1 deletion docs/EInvoicing/V1/DataInputFieldsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RecordSetCount** | **decimal** | Total count of results | [optional]
**RecordsetCount** | **decimal** | Total count of results | [optional]
**NextLink** | **string** | | [optional]
**Value** | [**List&lt;DataInputField&gt;**](DataInputField.md) | Array of Data Input Fields | [optional]

Expand Down
13 changes: 13 additions & 0 deletions docs/EInvoicing/V1/DirectorySearchResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Avalara.SDK.Model.EInvoicing.V1.DirectorySearchResponse
Response schema for directory search results

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RecordSetCount** | **int** | The count of records in the result set | [optional]
**NextLink** | **string** | The next page link to get the next set of results. | [optional]
**Value** | [**List&lt;DirectorySearchResponseValueInner&gt;**](DirectorySearchResponseValueInner.md) | | [optional]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

16 changes: 16 additions & 0 deletions docs/EInvoicing/V1/DirectorySearchResponseValueInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Avalara.SDK.Model.EInvoicing.V1.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** | **DateTime** | 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]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Avalara.SDK.Model.EInvoicing.V1.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]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Avalara.SDK.Model.EInvoicing.V1.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]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Avalara.SDK.Model.EInvoicing.V1.DirectorySearchResponseValueInnerSupportedDocumentTypesInner

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | Document type name. | [optional]
**Value** | **string** | Document type identifier. | [optional]
**SupportedByTradingPartner** | **bool** | Does trading partner support receiving this document type | [optional]
**SupportedByAvalara** | **bool** | Does avalara support exchanging this document type | [optional]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

12 changes: 12 additions & 0 deletions docs/EInvoicing/V1/DocumentFetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Avalara.SDK.Model.EInvoicing.V1.DocumentFetch

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Unique ID for this document that can be used for status checking and file downloads. This is a UID created by the Avalara E-Invoicing platform. | [optional]
**Status** | **string** | Status of the document | [optional]
**EventDateTime** | **string** | The date and time when the inbound document was accepted by the Avalara E-Invoicing Platform | [optional]

[[Back to Model list]](../../../README.md#documentation-for-models) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../README.md)

Loading
Loading