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

Release/24.12.10 #1

Merged
merged 7 commits into from
Jan 3, 2025
Merged
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
@@ -201,12 +201,20 @@ This PHP package is automatically generated by the [OpenAPI Generator](https://o

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
@@ -216,26 +224,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)
15 changes: 15 additions & 0 deletions docs/EInvoicing/BatchSearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # BatchSearch

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | ID of the batch search | [optional]
**name** | **string** | Name of the batch report | [optional]
**created_by** | **string** | Email of the user who created the batch search | [optional]
**created** | **\DateTime** | Timestamp when the batch search was created | [optional]
**last_modified** | **\DateTime** | Timestamp when the batch search was created | [optional]
**status** | **string** | Status of the batch search | [optional]
**error** | [**\Avalara\SDK\Model\EInvoicing\V1\ErrorResponse**](ErrorResponse.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
11 changes: 11 additions & 0 deletions docs/EInvoicing/BatchSearchListResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # BatchSearchListResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**at_record_set_count** | **int** | The count of records in the result set | [optional]
**at_next_link** | **string** | Next Link | [optional]
**value** | [**\Avalara\SDK\Model\EInvoicing\V1\BatchSearch[]**](BatchSearch.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
2 changes: 1 addition & 1 deletion docs/EInvoicing/DataInputField.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**field_id** | **string** | Field ID | [optional]
**applicable_document_roots** | **object[]** | | [optional]
**path** | **string** | Path to this field | [optional]
**name_space** | **string** | Namespace of this field | [optional]
**namespace** | **string** | Namespace of this field | [optional]
**field_name** | **string** | Field name | [optional]
**example_or_fixed_value** | **string** | An example of the content for this field | [optional]
**accepted_values** | **object** | An object representing the acceptable values for this field | [optional]
2 changes: 1 addition & 1 deletion docs/EInvoicing/DataInputFieldsResponse.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**at_record_set_count** | **float** | Total count of results | [optional]
**at_recordset_count** | **float** | Total count of results | [optional]
**at_next_link** | **string** | | [optional]
**value** | [**\Avalara\SDK\Model\EInvoicing\V1\DataInputField[]**](DataInputField.md) | Array of Data Input Fields | [optional]

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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**at_record_set_count** | **int** | The count of records in the result set | [optional]
**at_next_link** | **string** | The next page link to get the next set of results. | [optional]
**value** | [**\Avalara\SDK\Model\EInvoicing\V1\DirectorySearchResponseValueInner[]**](DirectorySearchResponseValueInner.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
15 changes: 15 additions & 0 deletions docs/EInvoicing/DirectorySearchResponseValueInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# # 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]
**registration_date** | **\DateTime** | Registration date of the participant if available | [optional]
**identifiers** | [**\Avalara\SDK\Model\EInvoicing\V1\DirectorySearchResponseValueInnerIdentifiersInner[]**](DirectorySearchResponseValueInnerIdentifiersInner.md) | | [optional]
**addresses** | [**\Avalara\SDK\Model\EInvoicing\V1\DirectorySearchResponseValueInnerAddressesInner[]**](DirectorySearchResponseValueInnerAddressesInner.md) | | [optional]
**supported_document_types** | [**\Avalara\SDK\Model\EInvoicing\V1\DirectorySearchResponseValueInnerSupportedDocumentTypesInner[]**](DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
13 changes: 13 additions & 0 deletions docs/EInvoicing/DirectorySearchResponseValueInnerAddressesInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# # 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#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # 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#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# # DirectorySearchResponseValueInnerSupportedDocumentTypesInner

## Properties

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

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
11 changes: 11 additions & 0 deletions docs/EInvoicing/DocumentFetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # 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]
**event_date_time** | **string** | The date and time when the inbound document was accepted by the Avalara E-Invoicing Platform | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
10 changes: 10 additions & 0 deletions docs/EInvoicing/DocumentFetchRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # DocumentFetchRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**\Avalara\SDK\Model\EInvoicing\V1\DocumentFetchRequestDataInner[]**](DocumentFetchRequestDataInner.md) | Array of key-value pairs used to retrieve inbound documents from the Tax Authority | [optional]
**metadata** | [**\Avalara\SDK\Model\EInvoicing\V1\DocumentFetchRequestMetadata**](DocumentFetchRequestMetadata.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
10 changes: 10 additions & 0 deletions docs/EInvoicing/DocumentFetchRequestDataInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# # DocumentFetchRequestDataInner

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** | Descriptor of the identifier |
**value** | **string** | Value of the identifier |

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
13 changes: 13 additions & 0 deletions docs/EInvoicing/DocumentFetchRequestMetadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# # DocumentFetchRequestMetadata

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**workflow_id** | **string** | Specifies a unique ID for this workflow. |
**data_format** | **string** | Specifies the data format for this workflow |
**data_format_version** | **float** | Specifies the data format version number |
**country_code** | **string** | The two-letter ISO-3166 country code for the country for which document is being retrieved |
**country_mandate** | **string** | The e-invoicing mandate for the specified country |

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
4 changes: 2 additions & 2 deletions docs/EInvoicing/DocumentListResponse.md
Original file line number Diff line number Diff line change
@@ -4,8 +4,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**at_record_set_count** | **string** | Count of collections for the given date range | [optional]
**at_recordset_count** | **string** | Count of collections for the given date range | [optional]
**at_next_link** | **string** | | [optional]
**value** | [**\Avalara\SDK\Model\EInvoicing\V1\DocumentSummary[]**](DocumentSummary.md) | Array of invoices matching query parameters |
**value** | [**\Avalara\SDK\Model\EInvoicing\V1\DocumentSummary[]**](DocumentSummary.md) | Array of documents matching query parameters |

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
2 changes: 1 addition & 1 deletion docs/EInvoicing/DocumentStatusResponse.md
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | The unique ID for this document | [optional]
**status** | **string** | Status of the transaction: &lt;br&gt; &#39;Pending&#39; &lt;br&gt; &#39;Failed&#39; &lt;br&gt; &#39;Complete&#39; | [optional]
**status** | **string** | Status of the document | [optional]
**events** | [**\Avalara\SDK\Model\EInvoicing\V1\StatusEvent[]**](StatusEvent.md) | | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
16 changes: 9 additions & 7 deletions docs/EInvoicing/DocumentSummary.md
Original file line number Diff line number Diff line change
@@ -6,15 +6,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | The unique ID for this document | [optional]
**process_date_time** | **string** | The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss | [optional]
**status** | **string** | The transaction status: &lt;br&gt; &#39;Pending&#39; &lt;br&gt; &#39;Failed&#39; &lt;br&gt; &#39;Complete&#39; | [optional]
**status** | **string** | The Document status | [optional]
**supplier_name** | **string** | The name of the supplier in the transaction | [optional]
**customer_name** | **string** | The name of the customer in the transaction | [optional]
**document_number** | **string** | The invoice document number | [optional]
**document_date** | **string** | The invoice issue date | [optional]
**flow** | **string** | The invoice direction, where issued &#x3D; &#x60;out&#x60; and received &#x3D; &#x60;in&#x60; | [optional]
**country_code** | **string** | The two-letter ISO-3166 country code for the country where the e-invoice is being submitted | [optional]
**document_type** | **string** | The document type | [optional]
**document_version** | **string** | The document version | [optional]
**document_number** | **string** | The document number | [optional]
**document_date** | **string** | The document issue date | [optional]
**flow** | **string** | The document direction, where issued &#x3D; &#x60;out&#x60; and received &#x3D; &#x60;in&#x60; | [optional]
**country_code** | **string** | The two-letter ISO-3166 country code for the country where the document is being submitted | [optional]
**country_mandate** | **string** | The e-invoicing mandate for the specified country | [optional]
**interface** | **string** | The interface where the invoice data is sent | [optional]
**receiver** | **string** | The invoice recipient based on the interface | [optional]
**interface** | **string** | The interface where the document is sent | [optional]
**receiver** | **string** | The document recipient based on the interface | [optional]

[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)
Loading