Skip to content

TaxIdentifiersApi.md

Latest commit

 

History

History
177 lines (130 loc) · 7.71 KB

TaxIdentifiersApi.md

File metadata and controls

177 lines (130 loc) · 7.71 KB
Raw

AvalaraSdk::EInvoicing::V1::TaxIdentifiersApi

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

Method HTTP request Description
tax_identifier_schema_by_country GET /tax-identifiers/schema Returns the tax identifier request and response schema for a specific country.
validate_tax_identifier POST /tax-identifiers/validate Validates a tax identifier.

tax_identifier_schema_by_country

tax_identifier_schema_by_country(avalara_version, country_code, opts)

Returns the tax identifier request and response schema for a specific country.

Returns the tax identifier request and response schema for a specific country.

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::EInvoicing::V1.configure do |config|
  # See Documentation for Authorization section in main README.md for more auth examples.
  config.bearer_token='<Your Avalara Identity Access Token>'
  config.environment='sandbox'
  config.app_name='testApp'
  config.app_version='1.2.3'
  config.machine_name='testMachine'
end

api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::EInvoicing::V1::TaxIdentifiersApi.new api_client

avalara_version = '1.6' # String | Header that specifies the API version to use (for example \"1.6\").
country_code = 'DE' # String | Two-letter ISO 3166 country code for which to retrieve the schema (for example \"DE\").
opts = {
  x_avalara_client: 'John's E-Invoicing-API Client', # String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
  x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43', # String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
  type: 'request' # String | Specifies which schema to return: \"request\" to receive the request validation schema or \"response\" to receive the response validation schema.
}

begin
  # Returns the tax identifier request and response schema for a specific country.
  result = api_instance.tax_identifier_schema_by_country(avalara_version, country_code, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling TaxIdentifiersApi->tax_identifier_schema_by_country: #{e}"
end

Using the tax_identifier_schema_by_country_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> tax_identifier_schema_by_country_with_http_info(avalara_version, country_code, opts)

begin
  # Returns the tax identifier request and response schema for a specific country.
  data, status_code, headers = api_instance.tax_identifier_schema_by_country_with_http_info(avalara_version, country_code, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TaxIdentifierSchemaByCountry200Response>
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
  puts "Error when calling TaxIdentifiersApi->tax_identifier_schema_by_country_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
avalara_version String Header that specifies the API version to use (for example &quot;1.6&quot;).
country_code String Two-letter ISO 3166 country code for which to retrieve the schema (for example &quot;DE&quot;).
x_avalara_client String Optional header for a client identifier string used for diagnostics (for example &quot;Fingerprint&quot;). [optional]
x_correlation_id String Optional correlation identifier provided by the caller to trace the call (for example &quot;f3f0d19a-01a1-4748-8a58-f000d0424f43&quot;). [optional]
type String Specifies which schema to return: &quot;request&quot; to receive the request validation schema or &quot;response&quot; to receive the response validation schema. [optional]

Return type

TaxIdentifierSchemaByCountry200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

validate_tax_identifier

validate_tax_identifier(avalara_version, tax_identifier_request, opts)

Validates a tax identifier.

This endpoint verifies whether a given tax identifier is valid and properly formatted according to the rules of the applicable country or tax system.

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::EInvoicing::V1.configure do |config|
  # See Documentation for Authorization section in main README.md for more auth examples.
  config.bearer_token='<Your Avalara Identity Access Token>'
  config.environment='sandbox'
  config.app_name='testApp'
  config.app_version='1.2.3'
  config.machine_name='testMachine'
end

api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::EInvoicing::V1::TaxIdentifiersApi.new api_client

avalara_version = '1.6' # String | Header that specifies the API version to use (for example \"1.6\").
tax_identifier_request = AvalaraSdk::EInvoicing::V1::TaxIdentifierRequest.new({country_code: 'country_code_example', identifier_type: 'identifier_type_example', identifier: 'identifier_example'}) # TaxIdentifierRequest | 
opts = {
  x_avalara_client: 'John's E-Invoicing-API Client', # String | Optional header for a client identifier string used for diagnostics (for example \"Fingerprint\").
  x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | Optional correlation identifier provided by the caller to trace the call (for example \"f3f0d19a-01a1-4748-8a58-f000d0424f43\").
}

begin
  # Validates a tax identifier.
  result = api_instance.validate_tax_identifier(avalara_version, tax_identifier_request, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling TaxIdentifiersApi->validate_tax_identifier: #{e}"
end

Using the validate_tax_identifier_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> validate_tax_identifier_with_http_info(avalara_version, tax_identifier_request, opts)

begin
  # Validates a tax identifier.
  data, status_code, headers = api_instance.validate_tax_identifier_with_http_info(avalara_version, tax_identifier_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TaxIdentifierResponse>
rescue AvalaraSdk::EInvoicing::V1::ApiError => e
  puts "Error when calling TaxIdentifiersApi->validate_tax_identifier_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
avalara_version String Header that specifies the API version to use (for example &quot;1.6&quot;).
tax_identifier_request TaxIdentifierRequest
x_avalara_client String Optional header for a client identifier string used for diagnostics (for example &quot;Fingerprint&quot;). [optional]
x_correlation_id String Optional correlation identifier provided by the caller to trace the call (for example &quot;f3f0d19a-01a1-4748-8a58-f000d0424f43&quot;). [optional]

Return type

TaxIdentifierResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json