Skip to content

Issuers1099Api.md

Latest commit

 

History

History
438 lines (325 loc) · 16.6 KB

Issuers1099Api.md

File metadata and controls

438 lines (325 loc) · 16.6 KB
Raw

AvalaraSdk::A1099::V2::Issuers1099Api

All URIs are relative to https://api-ava1099.edge.qa.us-east-1.aws.avalara.io/avalara1099

Method HTTP request Description
create_issuer POST /1099/issuers Create an issuer
delete_issuer DELETE /1099/issuers/{id} Delete an issuer
get_issuer GET /1099/issuers/{id} Retrieve an issuer
get_issuers GET /1099/issuers List issuers
update_issuer PUT /1099/issuers/{id} Update an issuer

create_issuer

create_issuer(avalara_version, opts)

Create an issuer

Create an issuer (also known as a Payer).

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::A1099::V2.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::A1099::V2::Issuers1099Api.new api_client

avalara_version = '2.0.0' # String | API version
opts = {
  x_correlation_id: '14e92c5a-0e21-4dcd-8e3f-59111c335ba3', # String | Unique correlation Id in a GUID format
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({business_name: 'business_name_example', telephone: 'telephone_example', tax_year: 37, country_code: 'country_code_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to create
}

begin
  # Create an issuer
  result = api_instance.create_issuer(avalara_version, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling Issuers1099Api->create_issuer: #{e}"
end

Using the create_issuer_with_http_info variant

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

<Array(, Integer, Hash)> create_issuer_with_http_info(avalara_version, opts)

begin
  # Create an issuer
  data, status_code, headers = api_instance.create_issuer_with_http_info(avalara_version, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IssuerWriteResponse>
rescue AvalaraSdk::A1099::V2::ApiError => e
  puts "Error when calling Issuers1099Api->create_issuer_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
avalara_version String API version
x_correlation_id String Unique correlation Id in a GUID format [optional]
x_avalara_client String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
issuer_request IssuerRequest The issuer to create [optional]

Return type

IssuerWriteResponse

Authorization

bearer

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

delete_issuer

delete_issuer(id, avalara_version, opts)

Delete an issuer

Delete an issuer (also known as a Payer).

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::A1099::V2.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::A1099::V2::Issuers1099Api.new api_client

id = 'id_example' # String | Id of the issuer to delete
avalara_version = '2.0.0' # String | API version
opts = {
  x_correlation_id: 'cc721fe4-7f1e-4228-87d2-9351c780d9e9', # String | Unique correlation Id in a GUID format
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
}

begin
  # Delete an issuer
  api_instance.delete_issuer(id, avalara_version, opts)
rescue AvalaraSdk::ApiError => e
  puts "Error when calling Issuers1099Api->delete_issuer: #{e}"
end

Using the delete_issuer_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_issuer_with_http_info(id, avalara_version, opts)

begin
  # Delete an issuer
  data, status_code, headers = api_instance.delete_issuer_with_http_info(id, avalara_version, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue AvalaraSdk::A1099::V2::ApiError => e
  puts "Error when calling Issuers1099Api->delete_issuer_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Id of the issuer to delete
avalara_version String API version
x_correlation_id String Unique correlation Id in a GUID format [optional]
x_avalara_client String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

nil (empty response body)

Authorization

bearer

HTTP request headers

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

get_issuer

get_issuer(id, avalara_version, opts)

Retrieve an issuer

Retrieve an issuer (also known as a Payer).

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::A1099::V2.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::A1099::V2::Issuers1099Api.new api_client

id = 'id_example' # String | Id of the issuer to retrieve
avalara_version = '2.0.0' # String | API version
opts = {
  x_correlation_id: '1c49f829-d029-4e67-8d87-c87a83033413', # String | Unique correlation Id in a GUID format
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
}

begin
  # Retrieve an issuer
  result = api_instance.get_issuer(id, avalara_version, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling Issuers1099Api->get_issuer: #{e}"
end

Using the get_issuer_with_http_info variant

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

<Array(, Integer, Hash)> get_issuer_with_http_info(id, avalara_version, opts)

begin
  # Retrieve an issuer
  data, status_code, headers = api_instance.get_issuer_with_http_info(id, avalara_version, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IssuerResponse>
rescue AvalaraSdk::A1099::V2::ApiError => e
  puts "Error when calling Issuers1099Api->get_issuer_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Id of the issuer to retrieve
avalara_version String API version
x_correlation_id String Unique correlation Id in a GUID format [optional]
x_avalara_client String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

IssuerResponse

Authorization

bearer

HTTP request headers

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

get_issuers

get_issuers(avalara_version, opts)

List issuers

List issuers (also known as Payers). Filterable fields are businessName, businessName2, referenceId, taxYear, firstName, and lastName.

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::A1099::V2.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::A1099::V2::Issuers1099Api.new api_client

avalara_version = '2.0.0' # String | API version
opts = {
  filter: 'taxYear eq 2025', # String | A filter statement to identify specific records to retrieve.  For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>.
  top: 56, # Integer | If zero or greater than 1000, return at most 1000 results.  Otherwise, return this number of results.  Used with skip to provide pagination for large datasets.
  skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
  count: true, # Boolean | If true, return the global count of elements in the collection.
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection.  It only applies when count=true.
  x_correlation_id: '7845d8ad-09ab-4ba4-a644-bc06bcb806b0', # String | Unique correlation Id in a GUID format
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
}

begin
  # List issuers
  result = api_instance.get_issuers(avalara_version, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling Issuers1099Api->get_issuers: #{e}"
end

Using the get_issuers_with_http_info variant

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

<Array(, Integer, Hash)> get_issuers_with_http_info(avalara_version, opts)

begin
  # List issuers
  data, status_code, headers = api_instance.get_issuers_with_http_info(avalara_version, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedQueryResultModelIssuerResponse>
rescue AvalaraSdk::A1099::V2::ApiError => e
  puts "Error when calling Issuers1099Api->get_issuers_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
avalara_version String API version
filter String A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=&quot;https://developer.avalara.com/avatax/filtering-in-rest/\&quot;&gt;Filtering in REST</a>. [optional]
top Integer If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets. [optional]
skip Integer If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. [optional]
order_by String A comma separated list of sort statements in the format (fieldname) [ASC DESC], for example id ASC.
count Boolean If true, return the global count of elements in the collection. [optional]
count_only Boolean If true, return ONLY the global count of elements in the collection. It only applies when count=true. [optional]
x_correlation_id String Unique correlation Id in a GUID format [optional]
x_avalara_client String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

PaginatedQueryResultModelIssuerResponse

Authorization

bearer

HTTP request headers

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

update_issuer

update_issuer(id, avalara_version, opts)

Update an issuer

Update an issuer (also known as a Payer). When the payload violates field-level business rules, the issuer is still persisted and the response body includes a validationErrors[] array describing each violation.

Examples

require 'time'
require 'avalara_sdk'
# setup authorization
AvalaraSdk::A1099::V2.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::A1099::V2::Issuers1099Api.new api_client

id = 'id_example' # String | Id of the issuer to update
avalara_version = '2.0.0' # String | API version
opts = {
  x_correlation_id: '484d0024-b885-4e06-aac7-bf3ab4daba3b', # String | Unique correlation Id in a GUID format
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({business_name: 'business_name_example', telephone: 'telephone_example', tax_year: 37, country_code: 'country_code_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to update
}

begin
  # Update an issuer
  result = api_instance.update_issuer(id, avalara_version, opts)
  p result
rescue AvalaraSdk::ApiError => e
  puts "Error when calling Issuers1099Api->update_issuer: #{e}"
end

Using the update_issuer_with_http_info variant

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

<Array(, Integer, Hash)> update_issuer_with_http_info(id, avalara_version, opts)

begin
  # Update an issuer
  data, status_code, headers = api_instance.update_issuer_with_http_info(id, avalara_version, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IssuerWriteResponse>
rescue AvalaraSdk::A1099::V2::ApiError => e
  puts "Error when calling Issuers1099Api->update_issuer_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Id of the issuer to update
avalara_version String API version
x_correlation_id String Unique correlation Id in a GUID format [optional]
x_avalara_client String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
issuer_request IssuerRequest The issuer to update [optional]

Return type

IssuerWriteResponse

Authorization

bearer

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json