Skip to content

Commit ea04c20

Browse files
author
Jonathan Wenger
committed
Updates for 24.12.10
1 parent 619692f commit ea04c20

File tree

77 files changed

+12118
-493
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+12118
-493
lines changed

‎README.md

+138-26
Large diffs are not rendered by default.

‎docs/EInvoicing/BatchSearch.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# # BatchSearch
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **string** | ID of the batch search | [optional]
8+
**name** | **string** | Name of the batch report | [optional]
9+
**created_by** | **string** | Email of the user who created the batch search | [optional]
10+
**created** | **\DateTime** | Timestamp when the batch search was created | [optional]
11+
**last_modified** | **\DateTime** | Timestamp when the batch search was created | [optional]
12+
**status** | **string** | Status of the batch search | [optional]
13+
**error** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\ErrorResponse**](ErrorResponse.md) | | [optional]
14+
15+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/BatchSearchListResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # BatchSearchListResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**at_record_set_count** | **int** | The count of records in the result set | [optional]
8+
**at_next_link** | **string** | Next Link | [optional]
9+
**value** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\BatchSearch[]**](BatchSearch.md) | | [optional]
10+
11+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/ConditionalForField.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**country_mandate** | **string** | | [optional]
8-
**required_when** | [**\Avalara\SDK\Model\EInvoicing\V1\RequiredWhenField[]**](RequiredWhenField.md) | Array of scenarios which describe when a particular field is conditional for a country mandate | [optional]
8+
**required_when** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\RequiredWhenField[]**](RequiredWhenField.md) | Array of scenarios which describe when a particular field is conditional for a country mandate | [optional]
99

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

‎docs/EInvoicing/DataInputField.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ Name | Type | Description | Notes
88
**field_id** | **string** | Field ID | [optional]
99
**applicable_document_roots** | **object[]** | | [optional]
1010
**path** | **string** | Path to this field | [optional]
11-
**name_space** | **string** | Namespace of this field | [optional]
11+
**namespace** | **string** | Namespace of this field | [optional]
1212
**field_name** | **string** | Field name | [optional]
1313
**example_or_fixed_value** | **string** | An example of the content for this field | [optional]
1414
**accepted_values** | **object** | An object representing the acceptable values for this field | [optional]
1515
**documentation_link** | **string** | An example of the content for this field | [optional]
1616
**description** | **string** | A description of this field | [optional]
1717
**is_segment** | **bool** | Is this a segment of the schema | [optional]
18-
**required_for** | [**\Avalara\SDK\Model\EInvoicing\V1\DataInputFieldRequiredFor**](DataInputFieldRequiredFor.md) | | [optional]
19-
**conditional_for** | [**\Avalara\SDK\Model\EInvoicing\V1\ConditionalForField[]**](ConditionalForField.md) | | [optional]
20-
**not_used_for** | [**\Avalara\SDK\Model\EInvoicing\V1\DataInputFieldNotUsedFor**](DataInputFieldNotUsedFor.md) | | [optional]
21-
**optional_for** | [**\Avalara\SDK\Model\EInvoicing\V1\DataInputFieldOptionalFor**](DataInputFieldOptionalFor.md) | | [optional]
18+
**required_for** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DataInputFieldRequiredFor**](DataInputFieldRequiredFor.md) | | [optional]
19+
**conditional_for** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\ConditionalForField[]**](ConditionalForField.md) | | [optional]
20+
**not_used_for** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DataInputFieldNotUsedFor**](DataInputFieldNotUsedFor.md) | | [optional]
21+
**optional_for** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DataInputFieldOptionalFor**](DataInputFieldOptionalFor.md) | | [optional]
2222

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

‎docs/EInvoicing/DataInputFieldsResponse.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

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

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

‎docs/EInvoicing/DirectorySearchResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # DirectorySearchResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**at_record_set_count** | **int** | The count of records in the result set | [optional]
8+
**at_next_link** | **string** | The next page link to get the next set of results. | [optional]
9+
**value** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DirectorySearchResponseValueInner[]**](DirectorySearchResponseValueInner.md) | | [optional]
10+
11+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DirectorySearchResponseValueInner.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# # DirectorySearchResponseValueInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **string** | Avalara unique ID of the participant in the directory. | [optional]
8+
**name** | **string** | Name of the participant (typically, the name of the business entity). | [optional]
9+
**network** | **string** | The network where the participant is present. | [optional]
10+
**registration_date** | **\DateTime** | Registration date of the participant if available | [optional]
11+
**identifiers** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DirectorySearchResponseValueInnerIdentifiersInner[]**](DirectorySearchResponseValueInnerIdentifiersInner.md) | | [optional]
12+
**addresses** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DirectorySearchResponseValueInnerAddressesInner[]**](DirectorySearchResponseValueInnerAddressesInner.md) | | [optional]
13+
**supported_document_types** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\DirectorySearchResponseValueInnerSupportedDocumentTypesInner[]**](DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md) | | [optional]
14+
15+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DirectorySearchResponseValueInnerAddressesInner.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # DirectorySearchResponseValueInnerAddressesInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**line1** | **string** | Address line 1 | [optional]
8+
**line2** | **string** | Address line 2 | [optional]
9+
**city** | **string** | City | [optional]
10+
**state** | **string** | State | [optional]
11+
**country** | **string** | Country | [optional]
12+
13+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DirectorySearchResponseValueInnerIdentifiersInner.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # DirectorySearchResponseValueInnerIdentifiersInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **string** | Peppol Participant ID if the participant is in Peppol network | [optional]
8+
**value** | **string** | Value of the identifier | [optional]
9+
10+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DirectorySearchResponseValueInnerSupportedDocumentTypesInner.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # DirectorySearchResponseValueInnerSupportedDocumentTypesInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **string** | Document type name. | [optional]
8+
**value** | **string** | Document type identifier. | [optional]
9+
**supported_by_trading_partner** | **bool** | Does trading partner support receiving this document type | [optional]
10+
**supported_by_avalara** | **bool** | Does avalara support exchanging this document type | [optional]
11+
12+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DocumentFetch.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # DocumentFetch
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**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]
8+
**status** | **string** | Status of the document | [optional]
9+
**event_date_time** | **string** | The date and time when the inbound document was accepted by the Avalara E-Invoicing Platform | [optional]
10+
11+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/DocumentListResponse.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

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

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

‎docs/EInvoicing/DocumentStatusResponse.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **string** | The unique ID for this document | [optional]
8-
**status** | **string** | Status of the transaction: <br> 'Pending' <br> 'Failed' <br> 'Complete' | [optional]
9-
**events** | [**\Avalara\SDK\Model\EInvoicing\V1\StatusEvent[]**](StatusEvent.md) | | [optional]
8+
**status** | **string** | Status of the document | [optional]
9+
**events** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\StatusEvent[]**](StatusEvent.md) | | [optional]
1010

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

‎docs/EInvoicing/DocumentSummary.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **string** | The unique ID for this document | [optional]
88
**process_date_time** | **string** | The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss | [optional]
9-
**status** | **string** | The transaction status: <br> 'Pending' <br> 'Failed' <br> 'Complete' | [optional]
9+
**status** | **string** | The Document status | [optional]
1010
**supplier_name** | **string** | The name of the supplier in the transaction | [optional]
1111
**customer_name** | **string** | The name of the customer in the transaction | [optional]
12-
**document_number** | **string** | The invoice document number | [optional]
13-
**document_date** | **string** | The invoice issue date | [optional]
14-
**flow** | **string** | The invoice direction, where issued = `out` and received = `in` | [optional]
15-
**country_code** | **string** | The two-letter ISO-3166 country code for the country where the e-invoice is being submitted | [optional]
12+
**document_type** | **string** | The document type | [optional]
13+
**document_version** | **string** | The document version | [optional]
14+
**document_number** | **string** | The document number | [optional]
15+
**document_date** | **string** | The document issue date | [optional]
16+
**flow** | **string** | The document direction, where issued = `out` and received = `in` | [optional]
17+
**country_code** | **string** | The two-letter ISO-3166 country code for the country where the document is being submitted | [optional]
1618
**country_mandate** | **string** | The e-invoicing mandate for the specified country | [optional]
17-
**interface** | **string** | The interface where the invoice data is sent | [optional]
18-
**receiver** | **string** | The invoice recipient based on the interface | [optional]
19+
**interface** | **string** | The interface where the document is sent | [optional]
20+
**receiver** | **string** | The document recipient based on the interface | [optional]
1921

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

‎docs/EInvoicing/ErrorResponse.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # ErrorResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**title** | **string** | | [optional]
8+
**status** | **string** | | [optional]
9+
**detail** | **string** | | [optional]
10+
**instance** | **string** | | [optional]
11+
12+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/FetchDocumentsRequest.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # FetchDocumentsRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**data** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\FetchDocumentsRequestDataInner[]**](FetchDocumentsRequestDataInner.md) | Array of key-value pairs used to retrieve inbound documents from the Tax Authority | [optional]
8+
**metadata** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\FetchDocumentsRequestMetadata**](FetchDocumentsRequestMetadata.md) | | [optional]
9+
10+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/FetchDocumentsRequestDataInner.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # FetchDocumentsRequestDataInner
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**key** | **string** | Descriptor of the identifier |
8+
**value** | **string** | Value of the identifier |
9+
10+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/FetchDocumentsRequestMetadata.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# # FetchDocumentsRequestMetadata
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**workflow_id** | **string** | Specifies a unique ID for this workflow. |
8+
**data_format** | **string** | Specifies the data format for this workflow |
9+
**data_format_version** | **float** | Specifies the data format version number |
10+
**country_code** | **string** | The two-letter ISO-3166 country code for the country for which document is being retrieved |
11+
**country_mandate** | **string** | The e-invoicing mandate for the specified country |
12+
13+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/InputDataFormats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**format** | **string** | Invoice format | [optional]
7+
**format** | **string** | Document format | [optional]
88
**versions** | **string[]** | | [optional]
99

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

‎docs/EInvoicing/Mandate.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**mandate_id** | **string** | Mandate UUID | [optional]
8-
**country_mandate** | **string** | Country mandate name | [optional]
7+
**mandate_id** | **string** | The `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL). Keep in mind the following when specifying a `mandateId`. - A country can have multiple mandate types (B2C, B2B, B2G). - A entity/company can opt in for multiple mandates. - A `mandateId` is the combination of country + mandate type + network/regulation. | [optional]
8+
**country_mandate** | **string** | **[LEGACY]** This field is retained for backward compatibility. It is recommended to use `mandateId` instead. The `countryMandate` similar to the `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL). | [optional]
99
**country_code** | **string** | Country code | [optional]
1010
**description** | **string** | Mandate description | [optional]
1111
**supported_by_partner_api** | **bool** | Indicates whether this mandate supported by the partner API | [optional]
1212
**mandate_format** | **string** | Mandate format | [optional]
13-
**input_data_formats** | [**\Avalara\SDK\Model\EInvoicing\V1\InputDataFormats[]**](InputDataFormats.md) | Format and version used when inputting the data | [optional]
14-
**workflow_ids** | [**\Avalara\SDK\Model\EInvoicing\V1\WorkflowIds[]**](WorkflowIds.md) | Workflow ID list | [optional]
13+
**input_data_formats** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\InputDataFormats[]**](InputDataFormats.md) | Format and version used when inputting the data | [optional]
14+
**workflow_ids** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\WorkflowIds[]**](WorkflowIds.md) | Workflow ID list | [optional]
1515

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

‎docs/EInvoicing/MandateDataInputField.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# # MandateDataInputField
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**field_id** | **string** | Field ID | [optional]
8+
**document_type** | **string** | The document type | [optional]
9+
**document_version** | **string** | The document version | [optional]
10+
**path** | **string** | Path to this field | [optional]
11+
**path_type** | **string** | The type of path | [optional]
12+
**field_name** | **string** | Field name | [optional]
13+
**namespace** | [**\Avalara\\SDK\Model\\EInvoicing\\V1\MandateDataInputFieldNamespace**](MandateDataInputFieldNamespace.md) | | [optional]
14+
**example_or_fixed_value** | **string** | An example of the content for this field | [optional]
15+
**accepted_values** | **string[]** | An Array representing the acceptable values for this field | [optional]
16+
**documentation_link** | **string** | An example of the content for this field | [optional]
17+
**data_type** | **string** | The data type of this field. | [optional]
18+
**description** | **string** | A description of this field | [optional]
19+
**optionality** | **string** | Determines if the field if Required/Conditional/Optional or not required. | [optional]
20+
**cardinality** | **string** | Represents the number of times an element can appear within the document | [optional]
21+
22+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

‎docs/EInvoicing/MandateDataInputFieldNamespace.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# # MandateDataInputFieldNamespace
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**prefix** | **string** | The namespace prefix for the UBL Element | [optional]
8+
**value** | **string** | | [optional]
9+
10+
[[Back to Model list]](../../../README.md#models) [[Back to API list]](../../../README.md#endpoints) [[Back to README]](../../../README.md)

0 commit comments

Comments
 (0)