All URIs are relative to https://api.sbx.avalara.com/einvoicing
| Method | HTTP request | Description |
|---|---|---|
| batch_search_participants | POST /trading-partners/batch-searches | Handles batch search requests by uploading a file containing search parameters. |
| create_trading_partner | POST /trading-partners | Creates a new trading partner. |
| create_trading_partners_batch | POST /trading-partners/batch | Creates a batch of multiple trading partners. |
| delete_trading_partner | DELETE /trading-partners/{id} | Deletes a trading partner using ID. |
| download_batch_search_report | GET /trading-partners/batch-searches/{id}/$download-results | Downloads batch search results in a csv file. |
| get_batch_search_detail | GET /trading-partners/batch-searches/{id} | Returns the batch search details using ID. |
| list_batch_searches | GET /trading-partners/batch-searches | Lists all batch searches that were previously submitted. |
| search_participants | GET /trading-partners | Returns a list of participants matching the input query. |
| update_trading_partner | PUT /trading-partners/{id} | Updates a trading partner using ID. |
BatchSearchParticipants202Response batch_search_participants(avalara_version, name, notification_email, file)
Handles batch search requests by uploading a file containing search parameters.
This endpoint creates a batch search and performs a batch search in the directory for participants in the background.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
BatchSearchParticipants202Response
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
name = 'Automotive Companies in London Search' # str | A human-readable name for the batch search.
notification_email = 'user@example.com' # str | The email address to which a notification will be sent once the batch search is complete.
file = None # bytearray | CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Handles batch search requests by uploading a file containing search parameters.
api_response = api_instance.batch_search_participants(avalara_version, name, notification_email, file)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->batch_search_participants: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Handles batch search requests by uploading a file containing search parameters.
api_response = api_instance.batch_search_participants(avalara_version, name, notification_email, file, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->batch_search_participants: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| name | str | A human-readable name for the batch search. | |
| notification_email | str | The email address to which a notification will be sent once the batch search is complete. | |
| file | bytearray | CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
BatchSearchParticipants202Response
- Content-Type: multipart/form-data
- Accept: application/json
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTradingPartner201Response create_trading_partner(avalara_version, trading_partner)
Creates a new trading partner.
This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the TradingPartner schema.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
CreateTradingPartner201Response
TradingPartner
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
trading_partner = {"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner |
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Creates a new trading partner.
api_response = api_instance.create_trading_partner(avalara_version, trading_partner)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->create_trading_partner: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Creates a new trading partner.
api_response = api_instance.create_trading_partner(avalara_version, trading_partner, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->create_trading_partner: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| trading_partner | TradingPartner | ||
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
CreateTradingPartner201Response
- Content-Type: application/json
- Accept: application/json
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTradingPartnersBatch200Response create_trading_partners_batch(avalara_version, create_trading_partners_batch_request)
Creates a batch of multiple trading partners.
This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or a 1 MB request payload.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
CreateTradingPartnersBatch200Response
CreateTradingPartnersBatchRequest
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
create_trading_partners_batch_request = {"value":[{"name":"Pineapple Labs ltd","network":"","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"addresses":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]}]} # CreateTradingPartnersBatchRequest |
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Creates a batch of multiple trading partners.
api_response = api_instance.create_trading_partners_batch(avalara_version, create_trading_partners_batch_request)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->create_trading_partners_batch: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Creates a batch of multiple trading partners.
api_response = api_instance.create_trading_partners_batch(avalara_version, create_trading_partners_batch_request, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->create_trading_partners_batch: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| create_trading_partners_batch_request | CreateTradingPartnersBatchRequest | ||
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
CreateTradingPartnersBatch200Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_trading_partner(avalara_version, id)
Deletes a trading partner using ID.
This endpoint deletes an existing trading partner identified by the provided ID.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
id = 'id_example' # str | Unique identifier of the trading partner.
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Deletes a trading partner using ID.
api_instance.delete_trading_partner(avalara_version, id)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->delete_trading_partner: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Deletes a trading partner using ID.
api_instance.delete_trading_partner(avalara_version, id, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->delete_trading_partner: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| id | str | Unique identifier of the trading partner. | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bytearray download_batch_search_report(avalara_version, id)
Downloads batch search results in a csv file.
This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | Unique identifier of the batch search for which to download the report.
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Downloads batch search results in a csv file.
api_response = api_instance.download_batch_search_report(avalara_version, id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->download_batch_search_report: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Downloads batch search results in a csv file.
api_response = api_instance.download_batch_search_report(avalara_version, id, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->download_batch_search_report: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| id | str | Unique identifier of the batch search for which to download the report. | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
bytearray
- Content-Type: Not defined
- Accept: text/csv, application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BatchSearch get_batch_search_detail(avalara_version, id)
Returns the batch search details using ID.
This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
BatchSearch
BatchSearchListResponse
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
id = '2f5ea4b5-4dae-445a-b3e4-9f65a61eaa99' # str | Unique identifier of the batch search.
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Returns the batch search details using ID.
api_response = api_instance.get_batch_search_detail(avalara_version, id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->get_batch_search_detail: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Returns the batch search details using ID.
api_response = api_instance.get_batch_search_detail(avalara_version, id, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->get_batch_search_detail: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| id | str | Unique identifier of the batch search. | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BatchSearchListResponse list_batch_searches(avalara_version)
Lists all batch searches that were previously submitted.
This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
BatchSearchListResponse
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
filter = 'name eq 'Batch_Search_Import_V4'' # str | 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 = true # bool | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. (optional)
top = 56 # int | The number of items to include in the result. (optional)
skip = 56 # int | The number of items to skip in the result. (optional)
order_by = 'name desc' # str | 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)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Lists all batch searches that were previously submitted.
api_response = api_instance.list_batch_searches(avalara_version)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->list_batch_searches: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Lists all batch searches that were previously submitted.
api_response = api_instance.list_batch_searches(avalara_version, x_avalara_client=x_avalara_client, filter=filter, count=count, top=top, skip=skip, order_by=order_by, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->list_batch_searches: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| filter | str | 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 | bool | When set to <code>true</code>, returns the total count of matching records included as <code>@recordSetCount</code> in the response body. | [optional] |
| top | int | The number of items to include in the result. | [optional] |
| skip | int | The number of items to skip in the result. | [optional] |
| order_by | str | 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] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchParticipants200Response search_participants(avalara_version, search)
Returns a list of participants matching the input query.
This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
SearchParticipants200Response
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
search = 'Acme AND 7726627177 OR BMW' # str | 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.
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
count = true # bool | When set to true, returns the total count of matching records included as @recordSetCount in the response body. (optional)
filter = 'network eq 'Peppol' and country eq 'Australia'' # str | 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 = 56 # int | The number of items to include in the result. (optional)
skip = 56 # int | The number of items to skip in the result. (optional)
order_by = 'name desc' # str | 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)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Returns a list of participants matching the input query.
api_response = api_instance.search_participants(avalara_version, search)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->search_participants: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Returns a list of participants matching the input query.
api_response = api_instance.search_participants(avalara_version, search, x_avalara_client=x_avalara_client, count=count, filter=filter, top=top, skip=skip, order_by=order_by, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->search_participants: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| search | str | 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. | |
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| count | bool | When set to true, returns the total count of matching records included as @recordSetCount in the response body. | [optional] |
| filter | str | 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 | int | The number of items to include in the result. | [optional] |
| skip | int | The number of items to skip in the result. | [optional] |
| order_by | str | 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] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateTradingPartner200Response update_trading_partner(avalara_version, id, trading_partner)
Updates a trading partner using ID.
This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.
- Bearer (JWT) Authentication (Bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.EInvoicing.V1 import trading_partners_api
UpdateTradingPartner200Response
TradingPartner
ErrorResponse
from pprint import pprint
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
app_name='test app'
app_version='1.0'
machine_name='some machine'
client_id='<Your Avalara Identity Client Id>'
client_secret='<Your Avalara Identity Client Secret>'
environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = trading_partners_api.TradingPartnersApi(api_client)
avalara_version = '1.6' # str | Header that specifies the API version to use (for example \"1.6\").
id = 'id_example' # str | Unique identifier of the trading partner.
trading_partner = {"name":"Pineapple Labs ltd","registrationDate":"2024-01-01T00:00:00.000Z","identifiers":[{"name":"urn:avalara:systems:des:directory:participant:identifiers:peppolparticipantid","displayName":"","value":"9930:de112233445","extensions":[]}],"address":[{"line1":"Line 1","line2":"Line 2","city":"Brisbane","state":"Queensland","country":"Australia","postalCode":"4000"}],"supportedDocumentTypes":[{"name":"","value":"busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1","supportedByTradingPartner":true,"supportedByAvalara":true,"extensions":[]}],"consents":{"listInAvalaraDirectory":true},"extensions":[]} # TradingPartner |
x_avalara_client = 'John's E-Invoicing-API Client' # str | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\"). (optional)
x_correlation_id = 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # str | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\"). (optional)
# example passing only required values which don't have defaults set
try:
# Updates a trading partner using ID.
api_response = api_instance.update_trading_partner(avalara_version, id, trading_partner)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->update_trading_partner: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Updates a trading partner using ID.
api_response = api_instance.update_trading_partner(avalara_version, id, trading_partner, x_avalara_client=x_avalara_client, x_correlation_id=x_correlation_id)
pprint(api_response)
except Avalara.SDK.ApiException as e:
print("Exception when calling TradingPartnersApi->update_trading_partner: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| avalara_version | str | Header that specifies the API version to use (for example "1.6"). | |
| id | str | Unique identifier of the trading partner. | |
| trading_partner | TradingPartner | ||
| x_avalara_client | str | Optional header for a client identifier string used for diagnostics (for example "Fingerprint"). | [optional] |
| x_correlation_id | str | Optional correlation identifier provided by the caller to trace the call (for example "f3f0d19a-01a1-4748-8a58-f000d0424f43"). | [optional] |
UpdateTradingPartner200Response
- Content-Type: application/json
- Accept: application/json
| 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 - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]