AvalaraSdk.EInvoicing.V1.TradingPartnersApi

All URIs are relative to https://api.sbx.avalara.com/einvoicing

Method	HTTP request	Description
batchSearchParticipants	POST /trading-partners/batch-searches	Creates a batch search and performs a batch search in the directory for participants in the background.
downloadBatchSearchReport	GET /trading-partners/batch-searches/{id}/$download-results	Download batch search results in a csv file.
getBatchSearchDetail	GET /trading-partners/batch-searches/{id}	Get the batch search details for a given id.
listBatchSearches	GET /trading-partners/batch-searches	List all batch searches that were previously submitted.
searchParticipants	GET /trading-partners	Returns a list of participants matching the input query.

batchSearchParticipants

void batchSearchParticipants (string avalaraVersion, string name, string notificationEmail, Blob file, string xAvalaraClient, string xCorrelationID)

Creates a batch search and performs a batch search in the directory for participants in the background.

Handles batch search requests by uploading a file containing search parameters.

Example

import * as AvalaraSdk from 'avalara-sdk';

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
    appName: 'asv-sdk-test-app',
    appVersion: '1.0',
    environment: AvaTaxEnvironment.Sandbox,
    machineName: 'test-machine',
    timeout:3000,
    bearerToken: 'YOUR_BEARER_TOKEN',
    testBasePath: 'https://localhost:3000'
};
const config = new AvalaraSdk.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.UserApi(client);
const result = await api.createUser();

Parameters

Name	Type	Description	Notes
avalaraVersion	string	The HTTP Header meant to specify the version of the API intended to be used	[default to undefined]
name	string	The human readable name given to this batch search.	[default to undefined]
notificationEmail	string	The email address of the user to whom the batch search completion notification must go to.	[default to undefined]
file	BlobBlob	CSV file containing search parameters.	[default to undefined]
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] [default to undefined]
xCorrelationID	string	The caller can use this as an identifier to use as a correlation id to trace the call.	[optional] [default to undefined]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

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]

downloadBatchSearchReport

Blob downloadBatchSearchReport (string avalaraVersion, string id, string xAvalaraClient, string xCorrelationID)

Download batch search results in a csv file.

Downloads the report for a specific batch search using the batch search ID.

Example

import * as AvalaraSdk from 'avalara-sdk';

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
    appName: 'asv-sdk-test-app',
    appVersion: '1.0',
    environment: AvaTaxEnvironment.Sandbox,
    machineName: 'test-machine',
    timeout:3000,
    bearerToken: 'YOUR_BEARER_TOKEN',
    testBasePath: 'https://localhost:3000'
};
const config = new AvalaraSdk.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.UserApi(client);
const result = await api.createUser();

Parameters

Name	Type	Description	Notes
avalaraVersion	string	The HTTP Header meant to specify the version of the API intended to be used	[default to undefined]
id	string	The ID of the batch search whose report is to be downloaded.	[default to undefined]
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] [default to undefined]
xCorrelationID	string	The caller can use this as an identifier to use as a correlation id to trace the call.	[optional] [default to undefined]

Return type

Blob

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: text/csv, application/json

HTTP response details

Status code	Description	Response headers
200	Successful report download	* 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]

getBatchSearchDetail

BatchSearch getBatchSearchDetail (string avalaraVersion, string id, string xAvalaraClient, string xCorrelationID)

Get the batch search details for a given id.

Example

import * as AvalaraSdk from 'avalara-sdk';

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
    appName: 'asv-sdk-test-app',
    appVersion: '1.0',
    environment: AvaTaxEnvironment.Sandbox,
    machineName: 'test-machine',
    timeout:3000,
    bearerToken: 'YOUR_BEARER_TOKEN',
    testBasePath: 'https://localhost:3000'
};
const config = new AvalaraSdk.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.UserApi(client);
const result = await api.createUser();

Parameters

Name	Type	Description	Notes
avalaraVersion	string	The HTTP Header meant to specify the version of the API intended to be used	[default to undefined]
id	string	The ID of the batch search that was submitted earlier.	[default to undefined]
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] [default to undefined]
xCorrelationID	string	The caller can use this as an identifier to use as a correlation id to trace the call.	[optional] [default to undefined]

Return type

BatchSearch

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get the batch search details for a given id.	* 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]

listBatchSearches

BatchSearchListResponse listBatchSearches (string avalaraVersion, string xAvalaraClient, string $filter, boolean count, string $top, string $skip, string $orderBy, string xCorrelationID)

List all batch searches that were previously submitted.

Retrieves all batch searches performed by the user.

Example

import * as AvalaraSdk from 'avalara-sdk';

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
    appName: 'asv-sdk-test-app',
    appVersion: '1.0',
    environment: AvaTaxEnvironment.Sandbox,
    machineName: 'test-machine',
    timeout:3000,
    bearerToken: 'YOUR_BEARER_TOKEN',
    testBasePath: 'https://localhost:3000'
};
const config = new AvalaraSdk.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.UserApi(client);
const result = await api.createUser();

Parameters

Name	Type	Description	Notes
avalaraVersion	string	The HTTP Header meant to specify the version of the API intended to be used	[default to undefined]
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] [default to undefined]
$filter	string	Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported is <code>name</code>. Refer to https://developer.avalara.com/avatax/filtering-in-rest/ for more information on filtering. Filtering will be done over the provided parameters.	[optional] [default to undefined]
count	boolean	When set to true, the count of the collection is included as @recordSetCount in the response body.	[optional] [default to undefined]
$top	string	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 200 records.	[optional] [default to undefined]
$skip	string	If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.	[optional] [default to undefined]
$orderBy	string	The $orderBy 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] [default to undefined]
xCorrelationID	string	The caller can use this as an identifier to use as a correlation id to trace the call.	[optional] [default to undefined]

Return type

BatchSearchListResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of batch searches	* 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]

searchParticipants

DirectorySearchResponse searchParticipants (string avalaraVersion, string $search, string xAvalaraClient, boolean count, string $filter, string $top, string $skip, string $orderBy, string xCorrelationID)

Returns a list of participants matching the input query.

Example

import * as AvalaraSdk from 'avalara-sdk';

const configParams: AvalaraSdk.Runtime.ConfigurationParameters = {
    appName: 'asv-sdk-test-app',
    appVersion: '1.0',
    environment: AvaTaxEnvironment.Sandbox,
    machineName: 'test-machine',
    timeout:3000,
    bearerToken: 'YOUR_BEARER_TOKEN',
    testBasePath: 'https://localhost:3000'
};
const config = new AvalaraSdk.Configuration(configParams);
let client = new AvalaraSdk.Runtime.ApiClient(config);
let api = new AvalaraSdk.EInvoicing.V1.UserApi(client);
const result = await api.createUser();

Parameters

Name	Type	Description	Notes
avalaraVersion	string	The HTTP Header meant to specify the version of the API intended to be used	[default to undefined]
$search	string	Search by value supports logical AND and OR. Refer to https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search for more information on search. Search will be done over <code>name</code> and <code>identifier</code> parameters only.	[default to undefined]
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] [default to undefined]
count	boolean	When set to true, the count of the collection is included as @recordSetCount in the response body.	[optional] [default to undefined]
$filter	string	Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported are <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. Refer to https://developer.avalara.com/avatax/filtering-in-rest/ for more information on filtering. Filtering will be done over the provided parameters.	[optional] [default to undefined]
$top	string	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 200 records.	[optional] [default to undefined]
$skip	string	If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.	[optional] [default to undefined]
$orderBy	string	The $orderBy 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] [default to undefined]
xCorrelationID	string	The caller can use this as an identifier to use as a correlation id to trace the call.	[optional] [default to undefined]

Return type

DirectorySearchResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* 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]

Files

TradingPartnersApi.md

Latest commit

History

TradingPartnersApi.md

File metadata and controls

AvalaraSdk.EInvoicing.V1.TradingPartnersApi

batchSearchParticipants

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadBatchSearchReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getBatchSearchDetail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listBatchSearches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

searchParticipants

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details