Class: AvaTax::Client

Inherits:

API

• Object
• API
• AvaTax::Client

Includes:

Accounts, Addresses, AgeVerification, Batches, CertExpressInvites, Companies, Contacts, Customers, Definitions, ECommerceToken, FilingCalendars, Filings, Free, FundingRequests, Items, JurisdictionOverrides, Locations, Nexus, Notices, Onboarding, PointOfSale, Registrar, Settings, ShippingVerification, Subscriptions, TaxCodes, TaxContent, TaxRules, Transactions, Upcs, Users, Utilities

Defined in:

lib/avatax/client.rb,
lib/avatax/client/ecms.rb,
lib/avatax/client/free.rb,
lib/avatax/client/upcs.rb,
lib/avatax/client/items.rb,
lib/avatax/client/nexus.rb,
lib/avatax/client/users.rb,
lib/avatax/client/batches.rb,
lib/avatax/client/filings.rb,
lib/avatax/client/notices.rb,
lib/avatax/client/reports.rb,
lib/avatax/client/accounts.rb,
lib/avatax/client/contacts.rb,
lib/avatax/client/settings.rb,
lib/avatax/client/taxcodes.rb,
lib/avatax/client/taxrules.rb,
lib/avatax/client/addresses.rb,
lib/avatax/client/companies.rb,
lib/avatax/client/customers.rb,
lib/avatax/client/glaccount.rb,
lib/avatax/client/locations.rb,
lib/avatax/client/registrar.rb,
lib/avatax/client/utilities.rb,
lib/avatax/client/compliance.rb,
lib/avatax/client/costcenter.rb,
lib/avatax/client/onboarding.rb,
lib/avatax/client/taxcontent.rb,
lib/avatax/client/datasources.rb,
lib/avatax/client/definitions.rb,
lib/avatax/client/pointofsale.rb,
lib/avatax/client/taxprofiles.rb,
lib/avatax/client/avafileforms.rb,
lib/avatax/client/certificates.rb,
lib/avatax/client/provisioning.rb,
lib/avatax/client/transactions.rb,
lib/avatax/client/advancedrules.rb,
lib/avatax/client/multidocument.rb,
lib/avatax/client/notifications.rb,
lib/avatax/client/subscriptions.rb,
lib/avatax/client/ecommercetoken.rb,
lib/avatax/client/ageverification.rb,
lib/avatax/client/apconfigsetting.rb,
lib/avatax/client/filingcalendars.rb,
lib/avatax/client/fundingrequests.rb,
lib/avatax/client/errortransactions.rb,
lib/avatax/client/userdefinedfields.rb,
lib/avatax/client/certexpressinvites.rb,
lib/avatax/client/distancethresholds.rb,
lib/avatax/client/firmclientlinkages.rb,
lib/avatax/client/shippingverification.rb,
lib/avatax/client/ecmeventnotifications.rb,
lib/avatax/client/jurisdictionoverrides.rb,
lib/avatax/client/communicationcertificates.rb,
lib/avatax/client/domaincontrolverification.rb,
lib/avatax/client/shippingverificationbatches.rb

Defined Under Namespace

Modules: APConfigSetting, Accounts, Addresses, AdvancedRules, AgeVerification, AvaFileForms, Batches, CertExpressInvites, Certificates, CommunicationCertificates, Companies, Compliance, Contacts, CostCenter, Customers, DataSources, Definitions, DistanceThresholds, DomainControlVerification, ECommerceToken, EcmEventNotifications, Ecms, ErrorTransactions, FilingCalendars, Filings, FirmClientLinkages, Free, FundingRequests, GLAccount, Items, JurisdictionOverrides, Locations, MultiDocument, Nexus, Notices, Notifications, Onboarding, PointOfSale, Provisioning, Registrar, Reports, Settings, ShippingVerification, ShippingVerificationBatches, Subscriptions, TaxCodes, TaxContent, TaxProfiles, TaxRules, Transactions, Upcs, UserDefinedFields, Users, Utilities

Method Summary

Methods included from ECommerceToken

#create_e_commerce_token, #refresh_e_commerce_token

Methods included from AgeVerification

#find_age_verification, #store_age_verification, #store_if_verified, #verify_age

Methods included from ShippingVerification

#deregister_shipment, #register_shipment, #register_shipment_if_compliant, #verify_shipment

Methods included from Utilities

#get_my_subscription, #list_my_subscriptions, #ping

Methods included from Users

#change_password, #create_users, #delete_user, #get_user, #get_user_entitlements, #list_users_by_account, #query_users, #update_user

Methods included from Upcs

#create_u_p_cs, #delete_u_p_c, #get_u_p_c, #list_u_p_cs_by_company, #query_u_p_cs, #update_u_p_c

Methods included from Transactions

#add_lines, #adjust_transaction, #audit_transaction, #audit_transaction_with_type, #bulk_lock_transaction, #change_transaction_code, #commit_transaction, #create_or_adjust_transaction, #create_transaction, #delete_lines, #get_all_variance_report_by_company_code, #get_transaction_by_code, #get_transaction_by_code_and_type, #get_transaction_by_id, #get_variance_report_by_company_code_by_transaction_id, #list_transactions_by_company, #lock_transaction, #refund_transaction, #settle_transaction, #uncommit_transaction, #unvoid_transaction, #variance_report, #verify_transaction, #void_transaction

Methods included from TaxRules

#create_country_coefficients, #create_tax_rules, #delete_tax_rule, #get_tax_rule, #list_country_coefficients, #list_tax_rules, #query_tax_rules, #update_tax_rule

Methods included from TaxContent

#build_tax_content_file, #build_tax_content_file_for_location, #download_tax_rates_by_zip_code, #tax_rates_by_address, #tax_rates_by_postal_code

Methods included from TaxCodes

#create_tax_codes, #delete_tax_code, #get_tax_code, #list_tax_codes_by_company, #query_tax_codes, #update_tax_code

Methods included from Subscriptions

#get_subscription, #list_subscriptions_by_account, #query_subscriptions

Methods included from Settings

#create_settings, #delete_setting, #get_setting, #list_settings_by_company, #query_settings, #update_setting

Methods included from Registrar

#create_account, #create_notifications, #create_subscriptions, #delete_account, #delete_notification, #delete_subscription, #list_service_types, #reset_password, #update_account, #update_notification, #update_subscription

Methods included from PointOfSale

#build_point_of_sale_data_file

Methods included from Onboarding

#request_new_account, #request_new_entitlement

Methods included from Notices

#create_notice_responsibility_type, #create_notice_root_cause_type, #delete_notice_responsibility_type, #delete_notice_root_cause_type

Methods included from Nexus

#create_nexus, #create_nexus_parameters, #declare_nexus_by_address, #delete_nexus, #delete_nexus_parameter, #delete_nexus_parameters, #get_nexus, #get_nexus_by_form_code, #get_nexus_parameter, #list_nexus_by_company, #list_nexus_by_company_and_tax_type_group, #list_nexus_parameters, #query_nexus, #update_nexus, #update_nexus_parameter

Methods included from Locations

#create_location_parameters, #create_locations, #delete_location, #delete_location_parameter, #get_location, #get_location_parameter, #list_location_parameters, #list_locations_by_company, #query_locations, #update_location, #update_location_parameter, #validate_location

Methods included from JurisdictionOverrides

#create_jurisdiction_overrides, #delete_jurisdiction_override, #get_jurisdiction_override, #list_jurisdiction_overrides_by_account, #query_jurisdiction_overrides, #update_jurisdiction_override

Methods included from Items

#batch_delete_item_classifications, #batch_delete_item_parameters, #bulk_upload_items, #create_item_classifications, #create_item_parameters, #create_item_tags, #create_items, #create_tax_code_classification_request, #delete_catalogue_item, #delete_item, #delete_item_classification, #delete_item_parameter, #delete_item_tag, #delete_item_tags, #get_item, #get_item_classification, #get_item_parameter, #get_item_tags, #get_item_tax_code_recommendations, #get_premium_classification, #list_import_restrictions, #list_item_classifications, #list_item_parameters, #list_items_by_company, #list_recommended_parameter_by_company_id_and_item_id, #query_items, #query_items_by_system_code, #query_items_by_tag, #sync_item_catalogue, #sync_items, #update_item, #update_item_classification, #update_item_parameter

Methods included from FundingRequests

#activate_funding_request, #funding_request_status

Methods included from Free

#request_free_trial

Methods included from Filings

#get_accrual_filings, #get_filed_returns

Methods included from FilingCalendars

#cycle_safe_options, #delete_company_return_settings, #legacy_filing_calendars

Methods included from Definitions

#get_cross_border_code, #get_login_verifier_by_form, #list_all_marketplace_locations, #list_ava_file_forms, #list_certificate_attributes, #list_certificate_exempt_reasons, #list_certificate_exposure_zones, #list_classification_parameters_usage, #list_communications_service_types, #list_communications_t_s_pairs, #list_communications_transaction_types, #list_countries, #list_cover_letters, #list_cross_border_codes, #list_cross_border_sections, #list_currencies, #list_entity_use_codes, #list_filing_frequencies, #list_items_recommendations_status, #list_items_status, #list_jurisdiction_types_by_rate_type_tax_type_mapping, #list_jurisdictions, #list_jurisdictions_by_address, #list_jurisdictions_by_rate_type_tax_type_mapping, #list_jurisdictions_hierarchy, #list_location_questions_by_address, #list_login_verifiers, #list_marketplace_locations, #list_nexus, #list_nexus_by_address, #list_nexus_by_country, #list_nexus_by_country_and_region, #list_nexus_by_form_code, #list_nexus_by_tax_type_group, #list_nexus_tax_type_groups, #list_notice_customer_funding_options, #list_notice_customer_types, #list_notice_filingtypes, #list_notice_priorities, #list_notice_reasons, #list_notice_responsibilities, #list_notice_root_causes, #list_notice_statuses, #list_notice_types, #list_parameters, #list_parameters_by_account, #list_parameters_by_item, #list_parameters_usage, #list_permissions, #list_postal_codes, #list_preferred_programs, #list_product_classification_systems, #list_product_classification_systems_by_company, #list_rate_types_by_country, #list_rate_types_by_country_tax_type_tax_sub_type, #list_regions, #list_regions_by_country, #list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type, #list_returns_parameters_usage, #list_security_roles, #list_subscription_types, #list_tags, #list_tax_authorities, #list_tax_authority_forms, #list_tax_authority_types, #list_tax_code_types, #list_tax_codes, #list_tax_forms, #list_tax_sub_types, #list_tax_sub_types_by_country_and_tax_type, #list_tax_sub_types_by_jurisdiction_and_region, #list_tax_type_groups, #list_tax_types_by_nexus_and_country, #list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type, #list_unit_of_measurement

Methods included from Customers

#create_customers, #delete_customer, #get_customer, #link_attributes_to_customer, #link_certificates_to_customer, #link_ship_to_customers_to_bill_customer, #list_attributes_for_customer, #list_certificates_for_customer, #list_valid_certificates_for_customer, #query_customers, #unlink_attributes_from_customer, #unlink_certificates_from_customer, #update_customer

Methods included from Contacts

#create_contacts, #delete_contact, #get_contact, #list_contacts_by_company, #query_contacts, #update_contact

Methods included from Companies

#certify_integration, #change_filing_status, #company_initialize, #create_companies, #create_company_parameters, #create_funding_request, #delete_company, #delete_company_parameter, #funding_configuration_by_company, #funding_configurations_by_company_and_currency, #get_company, #get_company_configuration, #get_company_parameter_detail, #get_filing_status, #list_a_c_h_entry_details_for_company, #list_company_parameter_details, #list_funding_requests_by_company, #list_mrs_companies, #query_companies, #set_company_configuration, #update_company, #update_company_parameter_detail

Methods included from CertExpressInvites

#create_cert_express_invitation, #get_cert_express_invitation, #list_cert_express_invitations

Methods included from Batches

#cancel_batch, #create_batches, #create_transaction_batch, #delete_batch, #download_batch, #get_batch, #list_batches_by_company, #query_batches

Methods included from Addresses

#resolve_address, #resolve_address_post

Methods included from Accounts

#account_reset_license_key, #activate_account, #audit_account, #create_license_key, #delete_license_key, #get_account, #get_account_configuration, #get_license_key, #get_license_keys, #list_mrs_accounts, #query_accounts, #set_account_configuration

Methods inherited from API

#config, #initialize

Methods included from Request

#delete, #get, #post, #put, #request

Constructor Details

This class inherits a constructor from AvaTax::API