net.avalara.avatax.rest.client

Class AvaTaxClient

java.lang.Object

net.avalara.avatax.rest.client.AvaTaxClient

public class AvaTaxClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AvaTaxClient(java.lang.String appName, java.lang.String appVersion, java.lang.String machineName, AvaTaxEnvironment environment)
AvaTaxClient(java.lang.String appName, java.lang.String appVersion, java.lang.String machineName, java.lang.String environmentUrl)

Method Summary

Modifier and Type	Method and Description
LicenseKeyModel	accountResetLicenseKey(java.lang.Integer id, ResetLicenseKeyModel model)
java.util.concurrent.Future<LicenseKeyModel>	accountResetLicenseKeyAsync(java.lang.Integer id, ResetLicenseKeyModel model) Reset this account's license key
TransactionModel	adjustTransaction(java.lang.String companyCode, java.lang.String transactionCode, AdjustTransactionModel model)
java.util.concurrent.Future<TransactionModel>	adjustTransactionAsync(java.lang.String companyCode, java.lang.String transactionCode, AdjustTransactionModel model) Correct a previously created transaction
java.lang.String	buildPointOfSaleDataFile(PointOfSaleDataRequestModel model)
java.util.concurrent.Future<java.lang.String>	buildPointOfSaleDataFileAsync(PointOfSaleDataRequestModel model) Point of sale data file generation
java.lang.String	buildPointOfSaleDataForLocation(java.lang.Integer companyId, java.lang.Integer id, java.util.Date date, java.lang.String format, java.lang.Integer partnerId, java.lang.Boolean includeJurisCodes)
java.util.concurrent.Future<java.lang.String>	buildPointOfSaleDataForLocationAsync(java.lang.Integer companyId, java.lang.Integer id, java.util.Date date, java.lang.String format, java.lang.Integer partnerId, java.lang.Boolean includeJurisCodes) Point of sale data file generation
TransactionModel	changeTransactionCode(java.lang.String companyCode, java.lang.String transactionCode, ChangeTransactionCodeModel model)
java.util.concurrent.Future<TransactionModel>	changeTransactionCodeAsync(java.lang.String companyCode, java.lang.String transactionCode, ChangeTransactionCodeModel model) Change a transaction's code
TransactionModel	commitTransaction(java.lang.String companyCode, java.lang.String transactionCode, CommitTransactionModel model)
java.util.concurrent.Future<TransactionModel>	commitTransactionAsync(java.lang.String companyCode, java.lang.String transactionCode, CommitTransactionModel model) Commit a transaction for reporting
CompanyModel	companyInitialize(CompanyInitializationModel model)
java.util.concurrent.Future<CompanyModel>	companyInitializeAsync(CompanyInitializationModel model) Quick setup for a company with a single physical address
java.util.ArrayList<BatchModel>	createBatches(java.lang.Integer companyId, java.util.ArrayList<BatchModel> model)
java.util.concurrent.Future<java.util.ArrayList<BatchModel>>	createBatchesAsync(java.lang.Integer companyId, java.util.ArrayList<BatchModel> model) Create a new batch
java.util.ArrayList<CompanyModel>	createCompanies(java.util.ArrayList<CompanyModel> model)
java.util.concurrent.Future<java.util.ArrayList<CompanyModel>>	createCompaniesAsync(java.util.ArrayList<CompanyModel> model) Create new companies
java.util.ArrayList<ContactModel>	createContacts(java.lang.Integer companyId, java.util.ArrayList<ContactModel> model)
java.util.concurrent.Future<java.util.ArrayList<ContactModel>>	createContactsAsync(java.lang.Integer companyId, java.util.ArrayList<ContactModel> model) Create a new contact
java.util.ArrayList<ItemModel>	createItems(java.lang.Integer companyId, java.util.ArrayList<ItemModel> model)
java.util.concurrent.Future<java.util.ArrayList<ItemModel>>	createItemsAsync(java.lang.Integer companyId, java.util.ArrayList<ItemModel> model) Create a new item
java.util.ArrayList<LocationModel>	createLocations(java.lang.Integer companyId, java.util.ArrayList<LocationModel> model)
java.util.concurrent.Future<java.util.ArrayList<LocationModel>>	createLocationsAsync(java.lang.Integer companyId, java.util.ArrayList<LocationModel> model) Create a new location
java.util.ArrayList<NexusModel>	createNexus(java.lang.Integer companyId, java.util.ArrayList<NexusModel> model)
java.util.concurrent.Future<java.util.ArrayList<NexusModel>>	createNexusAsync(java.lang.Integer companyId, java.util.ArrayList<NexusModel> model) Create a new nexus
java.util.ArrayList<SettingModel>	createSettings(java.lang.Integer companyId, java.util.ArrayList<SettingModel> model)
java.util.concurrent.Future<java.util.ArrayList<SettingModel>>	createSettingsAsync(java.lang.Integer companyId, java.util.ArrayList<SettingModel> model) Create a new setting
java.util.ArrayList<TaxCodeModel>	createTaxCodes(java.lang.Integer companyId, java.util.ArrayList<TaxCodeModel> model)
java.util.concurrent.Future<java.util.ArrayList<TaxCodeModel>>	createTaxCodesAsync(java.lang.Integer companyId, java.util.ArrayList<TaxCodeModel> model) Create a new tax code
java.util.ArrayList<TaxRuleModel>	createTaxRules(java.lang.Integer companyId, java.util.ArrayList<TaxRuleModel> model)
java.util.concurrent.Future<java.util.ArrayList<TaxRuleModel>>	createTaxRulesAsync(java.lang.Integer companyId, java.util.ArrayList<TaxRuleModel> model) Create a new tax rule
TransactionModel	createTransaction(CreateTransactionModel model)
java.util.concurrent.Future<TransactionModel>	createTransactionAsync(CreateTransactionModel model) Create a new transaction
java.util.ArrayList<UPCModel>	createUPCs(java.lang.Integer companyId, java.util.ArrayList<UPCModel> model)
java.util.concurrent.Future<java.util.ArrayList<UPCModel>>	createUPCsAsync(java.lang.Integer companyId, java.util.ArrayList<UPCModel> model) Create a new UPC
FetchResult<NexusModel>	definitionsNexusByCountryByRegionGet(java.lang.String country, java.lang.String region)
java.util.concurrent.Future<FetchResult<NexusModel>>	definitionsNexusByCountryByRegionGetAsync(java.lang.String country, java.lang.String region) Retrieve the full list of Avalara-supported nexus for a country and region.
FetchResult<NexusModel>	definitionsNexusByCountryGet(java.lang.String country)
java.util.concurrent.Future<FetchResult<NexusModel>>	definitionsNexusByCountryGetAsync(java.lang.String country) Retrieve the full list of Avalara-supported nexus for a country.
FetchResult<NexusModel>	definitionsNexusGet()
java.util.concurrent.Future<FetchResult<NexusModel>>	definitionsNexusGetAsync() Retrieve the full list of Avalara-supported nexus for all countries and regions.
ErrorResult	deleteBatch(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteBatchAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single batch
ErrorResult	deleteCompanies(java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteCompaniesAsync(java.lang.Integer id) Delete a single company
ErrorResult	deleteContact(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteContactAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single contact
ErrorResult	deleteItem(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteItemAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single item
ErrorResult	deleteLocation(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteLocationAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single location
ErrorResult	deleteNexus(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteNexusAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single nexus
ErrorResult	deleteSetting(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteSettingAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single setting
ErrorResult	deleteTaxCode(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteTaxCodeAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single tax code
ErrorResult	deleteTaxRule(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteTaxRuleAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single tax rule
ErrorResult	deleteUPC(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ErrorResult>	deleteUPCAsync(java.lang.Integer companyId, java.lang.Integer id) Delete a single UPC
AccountModel	getAccount(java.lang.Integer id, java.lang.String $include)
java.util.concurrent.Future<AccountModel>	getAccountAsync(java.lang.Integer id, java.lang.String $include) Retrieve a single account
BatchModel	getBatch(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<BatchModel>	getBatchAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single batch
CompanyModel	getCompany(java.lang.Integer id, java.lang.String $include)
java.util.concurrent.Future<CompanyModel>	getCompanyAsync(java.lang.Integer id, java.lang.String $include) Retrieve a single company
ContactModel	getContact(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ContactModel>	getContactAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single contact
ItemModel	getItem(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<ItemModel>	getItemAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single item
LocationModel	getLocation(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<LocationModel>	getLocationAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single location
SubscriptionModel	getMySubscription(java.lang.String serviceTypeId)
java.util.concurrent.Future<SubscriptionModel>	getMySubscriptionAsync(java.lang.String serviceTypeId) Checks if the current user is subscribed to a specific service
NexusModel	getNexus(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<NexusModel>	getNexusAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single nexus
SettingModel	getSetting(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<SettingModel>	getSettingAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single setting
SubscriptionModel	getSubscription(java.lang.Integer accountId, java.lang.Integer id)
java.util.concurrent.Future<SubscriptionModel>	getSubscriptionAsync(java.lang.Integer accountId, java.lang.Integer id) Retrieve a single subscription
TaxCodeModel	getTaxCode(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<TaxCodeModel>	getTaxCodeAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single tax code
TaxRuleModel	getTaxRule(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<TaxRuleModel>	getTaxRuleAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single tax rule
TransactionModel	getTransactionByCode(java.lang.String companyCode, java.lang.String transactionCode, java.lang.String $include)
java.util.concurrent.Future<TransactionModel>	getTransactionByCodeAsync(java.lang.String companyCode, java.lang.String transactionCode, java.lang.String $include) Retrieve a single transaction by code
TransactionModel	getTransactionById(java.lang.Long id, java.lang.String $include)
java.util.concurrent.Future<TransactionModel>	getTransactionByIdAsync(java.lang.Long id, java.lang.String $include) Retrieve a single transaction by ID
UPCModel	getUPC(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<UPCModel>	getUPCAsync(java.lang.Integer companyId, java.lang.Integer id) Retrieve a single UPC
UserModel	getUser(java.lang.Integer id, java.lang.Integer accountId, java.lang.String $include)
java.util.concurrent.Future<UserModel>	getUserAsync(java.lang.Integer id, java.lang.Integer accountId, java.lang.String $include) Retrieve a single user
UserEntitlementModel	getUserEntitlements(java.lang.Integer id, java.lang.Integer accountId)
java.util.concurrent.Future<UserEntitlementModel>	getUserEntitlementsAsync(java.lang.Integer id, java.lang.Integer accountId) Retrieve all entitlements for a single user
FetchResult<BatchModel>	listBatchesByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<BatchModel>>	listBatchesByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all batches for this company
FetchResult<ContactModel>	listContactsByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<ContactModel>>	listContactsByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve contacts for this company
FetchResult<IsoCountryModel>	listCountries()
java.util.concurrent.Future<FetchResult<IsoCountryModel>>	listCountriesAsync() List all ISO 3166 countries
FetchResult<ItemModel>	listItemsByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<ItemModel>>	listItemsByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve items for this company
FetchResult<LocationQuestionModel>	listLocationQuestionsByAddress(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country, java.math.BigDecimal latitude, java.math.BigDecimal longitude)
java.util.concurrent.Future<FetchResult<LocationQuestionModel>>	listLocationQuestionsByAddressAsync(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country, java.math.BigDecimal latitude, java.math.BigDecimal longitude) Retrieve the list of questions that are required for a tax location
FetchResult<LocationModel>	listLocationsByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<LocationModel>>	listLocationsByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve locations for this company
SubscriptionModel	listMySubscriptions()
java.util.concurrent.Future<SubscriptionModel>	listMySubscriptionsAsync() List all services to which the current user is subscribed
FetchResult<NexusModel>	listNexusByAddress(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country)
java.util.concurrent.Future<FetchResult<NexusModel>>	listNexusByAddressAsync(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country) List all nexus that apply to a specific address.
FetchResult<NexusModel>	listNexusByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<NexusModel>>	listNexusByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve nexus for this company
FetchResult<ParameterModel>	listParameters()
java.util.concurrent.Future<FetchResult<ParameterModel>>	listParametersAsync() Retrieve the full list of Avalara-supported extra parameters for creating transactions.
FetchResult<java.lang.String>	listPermissions()
java.util.concurrent.Future<FetchResult<java.lang.String>>	listPermissionsAsync() Retrieve the full list of Avalara-supported permissions
FetchResult<IsoRegionModel>	listRegions()
java.util.concurrent.Future<FetchResult<IsoRegionModel>>	listRegionsAsync() List all ISO 3166 regions
FetchResult<IsoRegionModel>	listRegionsByCountry(java.lang.String country)
java.util.concurrent.Future<FetchResult<IsoRegionModel>>	listRegionsByCountryAsync(java.lang.String country) List all ISO 3166 regions for a country
FetchResult<SecurityRoleModel>	listSecurityRoles()
java.util.concurrent.Future<FetchResult<SecurityRoleModel>>	listSecurityRolesAsync() Retrieve the full list of Avalara-supported permissions
FetchResult<SettingModel>	listSettingsByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<SettingModel>>	listSettingsByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all settings for this company
FetchResult<SubscriptionModel>	listSubscriptionsByAccount(java.lang.Integer accountId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<SubscriptionModel>>	listSubscriptionsByAccountAsync(java.lang.Integer accountId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve subscriptions for this account
FetchResult<SubscriptionTypeModel>	listSubscriptionTypes()
java.util.concurrent.Future<FetchResult<SubscriptionTypeModel>>	listSubscriptionTypesAsync() Retrieve the full list of Avalara-supported subscription types
FetchResult<TaxAuthorityModel>	listTaxAuthorities()
java.util.concurrent.Future<FetchResult<TaxAuthorityModel>>	listTaxAuthoritiesAsync() Retrieve the full list of Avalara-supported tax authorities.
FetchResult<TaxAuthorityFormModel>	listTaxAuthorityForms()
java.util.concurrent.Future<FetchResult<TaxAuthorityFormModel>>	listTaxAuthorityFormsAsync() Retrieve the full list of Avalara-supported forms for each tax authority.
FetchResult<TaxCodeModel>	listTaxCodes()
java.util.concurrent.Future<FetchResult<TaxCodeModel>>	listTaxCodesAsync() Retrieve the full list of Avalara-supported tax codes.
FetchResult<TaxCodeModel>	listTaxCodesByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<TaxCodeModel>>	listTaxCodesByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve tax codes for this company
TaxCodeTypesModel	listTaxCodeTypes()
java.util.concurrent.Future<TaxCodeTypesModel>	listTaxCodeTypesAsync() Retrieve the full list of Avalara-supported tax code types.
FetchResult<TaxRuleModel>	listTaxRules(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<TaxRuleModel>>	listTaxRulesAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve tax rules for this company
FetchResult<TransactionModel>	listTransactionsByCompany(java.lang.String companyCode, java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<TransactionModel>>	listTransactionsByCompanyAsync(java.lang.String companyCode, java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all transactions
FetchResult<UPCModel>	listUPCsByCompany(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<UPCModel>>	listUPCsByCompanyAsync(java.lang.Integer companyId, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve UPCs for this company
FetchResult<UserModel>	listUsersByAccount(java.lang.Integer accountId, java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<UserModel>>	listUsersByAccountAsync(java.lang.Integer accountId, java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve users for this account
PingResultModel	ping()
java.util.concurrent.Future<PingResultModel>	pingAsync() Tests connectivity and version of the service
FetchResult<BatchModel>	queryBatches(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<BatchModel>>	queryBatchesAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all batches
FetchResult<CompanyModel>	queryCompanies(java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<CompanyModel>>	queryCompaniesAsync(java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all companies
FetchResult<ContactModel>	queryContacts(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<ContactModel>>	queryContactsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all contacts
FetchResult<ItemModel>	queryItems(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<ItemModel>>	queryItemsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all items
FetchResult<LocationModel>	queryLocations(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<LocationModel>>	queryLocationsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all locations
FetchResult<NexusModel>	queryNexus(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<NexusModel>>	queryNexusAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all nexus
FetchResult<SettingModel>	querySettings(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<SettingModel>>	querySettingsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all settings
FetchResult<SubscriptionModel>	querySubscriptions(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<SubscriptionModel>>	querySubscriptionsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all subscriptions
FetchResult<TaxCodeModel>	queryTaxCodes(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<TaxCodeModel>>	queryTaxCodesAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all tax codes
FetchResult<TaxRuleModel>	queryTaxRules(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<TaxRuleModel>>	queryTaxRulesAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all tax rules
FetchResult<UPCModel>	queryUPCs(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<UPCModel>>	queryUPCsAsync(java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all UPCs
FetchResult<UserModel>	queryUsers(java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy)
java.util.concurrent.Future<FetchResult<UserModel>>	queryUsersAsync(java.lang.String $include, java.lang.String $filter, java.lang.Integer $top, java.lang.Integer $skip, java.lang.String $orderBy) Retrieve all users
AddressResolutionModel	resolveAddress(AddressInfo model)
java.util.concurrent.Future<AddressResolutionModel>	resolveAddressAsync(AddressInfo model) Retrieve geolocation information for a specified address
TransactionModel	settleTransaction(java.lang.String companyCode, java.lang.String transactionCode, SettleTransactionModel model)
java.util.concurrent.Future<TransactionModel>	settleTransactionAsync(java.lang.String companyCode, java.lang.String transactionCode, SettleTransactionModel model) Perform multiple actions on a transaction
TaxRateModel	taxRatesByAddress(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country)
java.util.concurrent.Future<TaxRateModel>	taxRatesByAddressAsync(java.lang.String line1, java.lang.String line2, java.lang.String line3, java.lang.String city, java.lang.String region, java.lang.String postalCode, java.lang.String country) Retrieve tax rates for a specified address
TaxRateModel	taxRatesByPostalCode(java.lang.String country, java.lang.String postalCode)
java.util.concurrent.Future<TaxRateModel>	taxRatesByPostalCodeAsync(java.lang.String country, java.lang.String postalCode) Retrieve tax rates for a specified country and postal code
BatchModel	updateBatch(java.lang.Integer companyId, java.lang.Integer id, BatchModel model)
java.util.concurrent.Future<BatchModel>	updateBatchAsync(java.lang.Integer companyId, java.lang.Integer id, BatchModel model) Update a single batch
CompanyModel	updateCompany(java.lang.Integer id, CompanyModel model)
java.util.concurrent.Future<CompanyModel>	updateCompanyAsync(java.lang.Integer id, CompanyModel model) Update a single company
ContactModel	updateContact(java.lang.Integer companyId, java.lang.Integer id, ContactModel model)
java.util.concurrent.Future<ContactModel>	updateContactAsync(java.lang.Integer companyId, java.lang.Integer id, ContactModel model) Update a single contact
ItemModel	updateItem(java.lang.Integer companyId, java.lang.Integer id, ItemModel model)
java.util.concurrent.Future<ItemModel>	updateItemAsync(java.lang.Integer companyId, java.lang.Integer id, ItemModel model) Update a single item
LocationModel	updateLocation(java.lang.Integer companyId, java.lang.Integer id, LocationModel model)
java.util.concurrent.Future<LocationModel>	updateLocationAsync(java.lang.Integer companyId, java.lang.Integer id, LocationModel model) Update a single location
NexusModel	updateNexus(java.lang.Integer companyId, java.lang.Integer id, NexusModel model)
java.util.concurrent.Future<NexusModel>	updateNexusAsync(java.lang.Integer companyId, java.lang.Integer id, NexusModel model) Update a single nexus
SettingModel	updateSetting(java.lang.Integer companyId, java.lang.Integer id, SettingModel model)
java.util.concurrent.Future<SettingModel>	updateSettingAsync(java.lang.Integer companyId, java.lang.Integer id, SettingModel model) Update a single setting
TaxCodeModel	updateTaxCode(java.lang.Integer companyId, java.lang.Integer id, TaxCodeModel model)
java.util.concurrent.Future<TaxCodeModel>	updateTaxCodeAsync(java.lang.Integer companyId, java.lang.Integer id, TaxCodeModel model) Update a single tax code
TaxRuleModel	updateTaxRule(java.lang.Integer companyId, java.lang.Integer id, TaxRuleModel model)
java.util.concurrent.Future<TaxRuleModel>	updateTaxRuleAsync(java.lang.Integer companyId, java.lang.Integer id, TaxRuleModel model) Update a single tax rule
UPCModel	updateUPC(java.lang.Integer companyId, java.lang.Integer id, UPCModel model)
java.util.concurrent.Future<UPCModel>	updateUPCAsync(java.lang.Integer companyId, java.lang.Integer id, UPCModel model) Update a single UPC
UserModel	updateUser(java.lang.Integer id, java.lang.Integer accountId, UserModel model)
java.util.concurrent.Future<UserModel>	updateUserAsync(java.lang.Integer id, java.lang.Integer accountId, UserModel model) Update a single user
LocationValidationModel	validateLocation(java.lang.Integer companyId, java.lang.Integer id)
java.util.concurrent.Future<LocationValidationModel>	validateLocationAsync(java.lang.Integer companyId, java.lang.Integer id) Validate the location against local requirements
TransactionModel	verifyTransaction(java.lang.String companyCode, java.lang.String transactionCode, VerifyTransactionModel model)
java.util.concurrent.Future<TransactionModel>	verifyTransactionAsync(java.lang.String companyCode, java.lang.String transactionCode, VerifyTransactionModel model) Verify a transaction
TransactionModel	voidTransaction(java.lang.String companyCode, java.lang.String transactionCode, VoidTransactionModel model)
java.util.concurrent.Future<TransactionModel>	voidTransactionAsync(java.lang.String companyCode, java.lang.String transactionCode, VoidTransactionModel model) Void a transaction
AvaTaxClient	withSecurity(java.lang.String securityHeader)
AvaTaxClient	withSecurity(java.lang.String username, java.lang.String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvaTaxClient

public AvaTaxClient(java.lang.String appName,
                    java.lang.String appVersion,
                    java.lang.String machineName,
                    AvaTaxEnvironment environment)

AvaTaxClient

public AvaTaxClient(java.lang.String appName,
                    java.lang.String appVersion,
                    java.lang.String machineName,
                    java.lang.String environmentUrl)

Method Detail

withSecurity

public AvaTaxClient withSecurity(java.lang.String securityHeader)

withSecurity

public AvaTaxClient withSecurity(java.lang.String username,
                                 java.lang.String password)

accountResetLicenseKeyAsync

public java.util.concurrent.Future<LicenseKeyModel> accountResetLicenseKeyAsync(java.lang.Integer id,
                                                                                ResetLicenseKeyModel model)

Reset this account's license key

accountResetLicenseKey

public LicenseKeyModel accountResetLicenseKey(java.lang.Integer id,
                                              ResetLicenseKeyModel model)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getAccountAsync

public java.util.concurrent.Future<AccountModel> getAccountAsync(java.lang.Integer id,
                                                                 java.lang.String $include)

Retrieve a single account

getAccount

public AccountModel getAccount(java.lang.Integer id,
                               java.lang.String $include)
                        throws java.lang.Exception

Throws:

java.lang.Exception

resolveAddressAsync

public java.util.concurrent.Future<AddressResolutionModel> resolveAddressAsync(AddressInfo model)

Retrieve geolocation information for a specified address

resolveAddress

public AddressResolutionModel resolveAddress(AddressInfo model)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

createBatchesAsync

public java.util.concurrent.Future<java.util.ArrayList<BatchModel>> createBatchesAsync(java.lang.Integer companyId,
                                                                                       java.util.ArrayList<BatchModel> model)

Create a new batch

createBatches

public java.util.ArrayList<BatchModel> createBatches(java.lang.Integer companyId,
                                                     java.util.ArrayList<BatchModel> model)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

deleteBatchAsync

public java.util.concurrent.Future<ErrorResult> deleteBatchAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Delete a single batch

deleteBatch

public ErrorResult deleteBatch(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getBatchAsync

public java.util.concurrent.Future<BatchModel> getBatchAsync(java.lang.Integer companyId,
                                                             java.lang.Integer id)

Retrieve a single batch

getBatch

public BatchModel getBatch(java.lang.Integer companyId,
                           java.lang.Integer id)
                    throws java.lang.Exception

Throws:

java.lang.Exception

listBatchesByCompanyAsync

public java.util.concurrent.Future<FetchResult<BatchModel>> listBatchesByCompanyAsync(java.lang.Integer companyId,
                                                                                      java.lang.String $filter,
                                                                                      java.lang.Integer $top,
                                                                                      java.lang.Integer $skip,
                                                                                      java.lang.String $orderBy)

Retrieve all batches for this company

listBatchesByCompany

public FetchResult<BatchModel> listBatchesByCompany(java.lang.Integer companyId,
                                                    java.lang.String $filter,
                                                    java.lang.Integer $top,
                                                    java.lang.Integer $skip,
                                                    java.lang.String $orderBy)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

queryBatchesAsync

public java.util.concurrent.Future<FetchResult<BatchModel>> queryBatchesAsync(java.lang.String $filter,
                                                                              java.lang.Integer $top,
                                                                              java.lang.Integer $skip,
                                                                              java.lang.String $orderBy)

Retrieve all batches

queryBatches

public FetchResult<BatchModel> queryBatches(java.lang.String $filter,
                                            java.lang.Integer $top,
                                            java.lang.Integer $skip,
                                            java.lang.String $orderBy)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

updateBatchAsync

public java.util.concurrent.Future<BatchModel> updateBatchAsync(java.lang.Integer companyId,
                                                                java.lang.Integer id,
                                                                BatchModel model)

Update a single batch

updateBatch

public BatchModel updateBatch(java.lang.Integer companyId,
                              java.lang.Integer id,
                              BatchModel model)
                       throws java.lang.Exception

Throws:

java.lang.Exception

companyInitializeAsync

public java.util.concurrent.Future<CompanyModel> companyInitializeAsync(CompanyInitializationModel model)

Quick setup for a company with a single physical address

companyInitialize

public CompanyModel companyInitialize(CompanyInitializationModel model)
                               throws java.lang.Exception

Throws:

java.lang.Exception

createCompaniesAsync

public java.util.concurrent.Future<java.util.ArrayList<CompanyModel>> createCompaniesAsync(java.util.ArrayList<CompanyModel> model)

Create new companies

createCompanies

public java.util.ArrayList<CompanyModel> createCompanies(java.util.ArrayList<CompanyModel> model)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

deleteCompaniesAsync

public java.util.concurrent.Future<ErrorResult> deleteCompaniesAsync(java.lang.Integer id)

Delete a single company

deleteCompanies

public ErrorResult deleteCompanies(java.lang.Integer id)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getCompanyAsync

public java.util.concurrent.Future<CompanyModel> getCompanyAsync(java.lang.Integer id,
                                                                 java.lang.String $include)

Retrieve a single company

getCompany

public CompanyModel getCompany(java.lang.Integer id,
                               java.lang.String $include)
                        throws java.lang.Exception

Throws:

java.lang.Exception

queryCompaniesAsync

public java.util.concurrent.Future<FetchResult<CompanyModel>> queryCompaniesAsync(java.lang.String $include,
                                                                                  java.lang.String $filter,
                                                                                  java.lang.Integer $top,
                                                                                  java.lang.Integer $skip,
                                                                                  java.lang.String $orderBy)

Retrieve all companies

queryCompanies

public FetchResult<CompanyModel> queryCompanies(java.lang.String $include,
                                                java.lang.String $filter,
                                                java.lang.Integer $top,
                                                java.lang.Integer $skip,
                                                java.lang.String $orderBy)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

updateCompanyAsync

public java.util.concurrent.Future<CompanyModel> updateCompanyAsync(java.lang.Integer id,
                                                                    CompanyModel model)

Update a single company

updateCompany

public CompanyModel updateCompany(java.lang.Integer id,
                                  CompanyModel model)
                           throws java.lang.Exception

Throws:

java.lang.Exception

createContactsAsync

public java.util.concurrent.Future<java.util.ArrayList<ContactModel>> createContactsAsync(java.lang.Integer companyId,
                                                                                          java.util.ArrayList<ContactModel> model)

Create a new contact

createContacts

public java.util.ArrayList<ContactModel> createContacts(java.lang.Integer companyId,
                                                        java.util.ArrayList<ContactModel> model)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteContactAsync

public java.util.concurrent.Future<ErrorResult> deleteContactAsync(java.lang.Integer companyId,
                                                                   java.lang.Integer id)

Delete a single contact

deleteContact

public ErrorResult deleteContact(java.lang.Integer companyId,
                                 java.lang.Integer id)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getContactAsync

public java.util.concurrent.Future<ContactModel> getContactAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Retrieve a single contact

getContact

public ContactModel getContact(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

listContactsByCompanyAsync

public java.util.concurrent.Future<FetchResult<ContactModel>> listContactsByCompanyAsync(java.lang.Integer companyId,
                                                                                         java.lang.String $filter,
                                                                                         java.lang.Integer $top,
                                                                                         java.lang.Integer $skip,
                                                                                         java.lang.String $orderBy)

Retrieve contacts for this company

listContactsByCompany

public FetchResult<ContactModel> listContactsByCompany(java.lang.Integer companyId,
                                                       java.lang.String $filter,
                                                       java.lang.Integer $top,
                                                       java.lang.Integer $skip,
                                                       java.lang.String $orderBy)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

queryContactsAsync

public java.util.concurrent.Future<FetchResult<ContactModel>> queryContactsAsync(java.lang.String $filter,
                                                                                 java.lang.Integer $top,
                                                                                 java.lang.Integer $skip,
                                                                                 java.lang.String $orderBy)

Retrieve all contacts

queryContacts

public FetchResult<ContactModel> queryContacts(java.lang.String $filter,
                                               java.lang.Integer $top,
                                               java.lang.Integer $skip,
                                               java.lang.String $orderBy)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

updateContactAsync

public java.util.concurrent.Future<ContactModel> updateContactAsync(java.lang.Integer companyId,
                                                                    java.lang.Integer id,
                                                                    ContactModel model)

Update a single contact

updateContact

public ContactModel updateContact(java.lang.Integer companyId,
                                  java.lang.Integer id,
                                  ContactModel model)
                           throws java.lang.Exception

Throws:

java.lang.Exception

definitionsNexusByCountryByRegionGetAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> definitionsNexusByCountryByRegionGetAsync(java.lang.String country,
                                                                                                      java.lang.String region)

Retrieve the full list of Avalara-supported nexus for a country and region.

definitionsNexusByCountryByRegionGet

public FetchResult<NexusModel> definitionsNexusByCountryByRegionGet(java.lang.String country,
                                                                    java.lang.String region)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

definitionsNexusByCountryGetAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> definitionsNexusByCountryGetAsync(java.lang.String country)

Retrieve the full list of Avalara-supported nexus for a country.

definitionsNexusByCountryGet

public FetchResult<NexusModel> definitionsNexusByCountryGet(java.lang.String country)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

definitionsNexusGetAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> definitionsNexusGetAsync()

Retrieve the full list of Avalara-supported nexus for all countries and regions.

definitionsNexusGet

public FetchResult<NexusModel> definitionsNexusGet()
                                            throws java.lang.Exception

Throws:

java.lang.Exception

listCountriesAsync

public java.util.concurrent.Future<FetchResult<IsoCountryModel>> listCountriesAsync()

List all ISO 3166 countries

listCountries

public FetchResult<IsoCountryModel> listCountries()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

listLocationQuestionsByAddressAsync

public java.util.concurrent.Future<FetchResult<LocationQuestionModel>> listLocationQuestionsByAddressAsync(java.lang.String line1,
                                                                                                           java.lang.String line2,
                                                                                                           java.lang.String line3,
                                                                                                           java.lang.String city,
                                                                                                           java.lang.String region,
                                                                                                           java.lang.String postalCode,
                                                                                                           java.lang.String country,
                                                                                                           java.math.BigDecimal latitude,
                                                                                                           java.math.BigDecimal longitude)

Retrieve the list of questions that are required for a tax location

listLocationQuestionsByAddress

public FetchResult<LocationQuestionModel> listLocationQuestionsByAddress(java.lang.String line1,
                                                                         java.lang.String line2,
                                                                         java.lang.String line3,
                                                                         java.lang.String city,
                                                                         java.lang.String region,
                                                                         java.lang.String postalCode,
                                                                         java.lang.String country,
                                                                         java.math.BigDecimal latitude,
                                                                         java.math.BigDecimal longitude)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

listNexusByAddressAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> listNexusByAddressAsync(java.lang.String line1,
                                                                                    java.lang.String line2,
                                                                                    java.lang.String line3,
                                                                                    java.lang.String city,
                                                                                    java.lang.String region,
                                                                                    java.lang.String postalCode,
                                                                                    java.lang.String country)

List all nexus that apply to a specific address.

listNexusByAddress

public FetchResult<NexusModel> listNexusByAddress(java.lang.String line1,
                                                  java.lang.String line2,
                                                  java.lang.String line3,
                                                  java.lang.String city,
                                                  java.lang.String region,
                                                  java.lang.String postalCode,
                                                  java.lang.String country)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

listParametersAsync

public java.util.concurrent.Future<FetchResult<ParameterModel>> listParametersAsync()

Retrieve the full list of Avalara-supported extra parameters for creating transactions.

listParameters

public FetchResult<ParameterModel> listParameters()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

listPermissionsAsync

public java.util.concurrent.Future<FetchResult<java.lang.String>> listPermissionsAsync()

Retrieve the full list of Avalara-supported permissions

listPermissions

public FetchResult<java.lang.String> listPermissions()
                                              throws java.lang.Exception

Throws:

java.lang.Exception

listRegionsAsync

public java.util.concurrent.Future<FetchResult<IsoRegionModel>> listRegionsAsync()

List all ISO 3166 regions

listRegions

public FetchResult<IsoRegionModel> listRegions()
                                        throws java.lang.Exception

Throws:

java.lang.Exception

listRegionsByCountryAsync

public java.util.concurrent.Future<FetchResult<IsoRegionModel>> listRegionsByCountryAsync(java.lang.String country)

List all ISO 3166 regions for a country

listRegionsByCountry

public FetchResult<IsoRegionModel> listRegionsByCountry(java.lang.String country)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

listSecurityRolesAsync

public java.util.concurrent.Future<FetchResult<SecurityRoleModel>> listSecurityRolesAsync()

Retrieve the full list of Avalara-supported permissions

listSecurityRoles

public FetchResult<SecurityRoleModel> listSecurityRoles()
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

listSubscriptionTypesAsync

public java.util.concurrent.Future<FetchResult<SubscriptionTypeModel>> listSubscriptionTypesAsync()

Retrieve the full list of Avalara-supported subscription types

listSubscriptionTypes

public FetchResult<SubscriptionTypeModel> listSubscriptionTypes()
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

listTaxAuthoritiesAsync

public java.util.concurrent.Future<FetchResult<TaxAuthorityModel>> listTaxAuthoritiesAsync()

Retrieve the full list of Avalara-supported tax authorities.

listTaxAuthorities

public FetchResult<TaxAuthorityModel> listTaxAuthorities()
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

listTaxAuthorityFormsAsync

public java.util.concurrent.Future<FetchResult<TaxAuthorityFormModel>> listTaxAuthorityFormsAsync()

Retrieve the full list of Avalara-supported forms for each tax authority.

listTaxAuthorityForms

public FetchResult<TaxAuthorityFormModel> listTaxAuthorityForms()
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

listTaxCodeTypesAsync

public java.util.concurrent.Future<TaxCodeTypesModel> listTaxCodeTypesAsync()

Retrieve the full list of Avalara-supported tax code types.

listTaxCodeTypes

public TaxCodeTypesModel listTaxCodeTypes()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

listTaxCodesAsync

public java.util.concurrent.Future<FetchResult<TaxCodeModel>> listTaxCodesAsync()

Retrieve the full list of Avalara-supported tax codes.

listTaxCodes

public FetchResult<TaxCodeModel> listTaxCodes()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

createItemsAsync

public java.util.concurrent.Future<java.util.ArrayList<ItemModel>> createItemsAsync(java.lang.Integer companyId,
                                                                                    java.util.ArrayList<ItemModel> model)

Create a new item

createItems

public java.util.ArrayList<ItemModel> createItems(java.lang.Integer companyId,
                                                  java.util.ArrayList<ItemModel> model)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

deleteItemAsync

public java.util.concurrent.Future<ErrorResult> deleteItemAsync(java.lang.Integer companyId,
                                                                java.lang.Integer id)

Delete a single item

deleteItem

public ErrorResult deleteItem(java.lang.Integer companyId,
                              java.lang.Integer id)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getItemAsync

public java.util.concurrent.Future<ItemModel> getItemAsync(java.lang.Integer companyId,
                                                           java.lang.Integer id)

Retrieve a single item

getItem

public ItemModel getItem(java.lang.Integer companyId,
                         java.lang.Integer id)
                  throws java.lang.Exception

Throws:

java.lang.Exception

listItemsByCompanyAsync

public java.util.concurrent.Future<FetchResult<ItemModel>> listItemsByCompanyAsync(java.lang.Integer companyId,
                                                                                   java.lang.String $filter,
                                                                                   java.lang.Integer $top,
                                                                                   java.lang.Integer $skip,
                                                                                   java.lang.String $orderBy)

Retrieve items for this company

listItemsByCompany

public FetchResult<ItemModel> listItemsByCompany(java.lang.Integer companyId,
                                                 java.lang.String $filter,
                                                 java.lang.Integer $top,
                                                 java.lang.Integer $skip,
                                                 java.lang.String $orderBy)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

queryItemsAsync

public java.util.concurrent.Future<FetchResult<ItemModel>> queryItemsAsync(java.lang.String $filter,
                                                                           java.lang.Integer $top,
                                                                           java.lang.Integer $skip,
                                                                           java.lang.String $orderBy)

Retrieve all items

queryItems

public FetchResult<ItemModel> queryItems(java.lang.String $filter,
                                         java.lang.Integer $top,
                                         java.lang.Integer $skip,
                                         java.lang.String $orderBy)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

updateItemAsync

public java.util.concurrent.Future<ItemModel> updateItemAsync(java.lang.Integer companyId,
                                                              java.lang.Integer id,
                                                              ItemModel model)

Update a single item

updateItem

public ItemModel updateItem(java.lang.Integer companyId,
                            java.lang.Integer id,
                            ItemModel model)
                     throws java.lang.Exception

Throws:

java.lang.Exception

buildPointOfSaleDataForLocationAsync

public java.util.concurrent.Future<java.lang.String> buildPointOfSaleDataForLocationAsync(java.lang.Integer companyId,
                                                                                          java.lang.Integer id,
                                                                                          java.util.Date date,
                                                                                          java.lang.String format,
                                                                                          java.lang.Integer partnerId,
                                                                                          java.lang.Boolean includeJurisCodes)

Point of sale data file generation

buildPointOfSaleDataForLocation

public java.lang.String buildPointOfSaleDataForLocation(java.lang.Integer companyId,
                                                        java.lang.Integer id,
                                                        java.util.Date date,
                                                        java.lang.String format,
                                                        java.lang.Integer partnerId,
                                                        java.lang.Boolean includeJurisCodes)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

createLocationsAsync

public java.util.concurrent.Future<java.util.ArrayList<LocationModel>> createLocationsAsync(java.lang.Integer companyId,
                                                                                            java.util.ArrayList<LocationModel> model)

Create a new location

createLocations

public java.util.ArrayList<LocationModel> createLocations(java.lang.Integer companyId,
                                                          java.util.ArrayList<LocationModel> model)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

deleteLocationAsync

public java.util.concurrent.Future<ErrorResult> deleteLocationAsync(java.lang.Integer companyId,
                                                                    java.lang.Integer id)

Delete a single location

deleteLocation

public ErrorResult deleteLocation(java.lang.Integer companyId,
                                  java.lang.Integer id)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getLocationAsync

public java.util.concurrent.Future<LocationModel> getLocationAsync(java.lang.Integer companyId,
                                                                   java.lang.Integer id)

Retrieve a single location

getLocation

public LocationModel getLocation(java.lang.Integer companyId,
                                 java.lang.Integer id)
                          throws java.lang.Exception

Throws:

java.lang.Exception

listLocationsByCompanyAsync

public java.util.concurrent.Future<FetchResult<LocationModel>> listLocationsByCompanyAsync(java.lang.Integer companyId,
                                                                                           java.lang.String $filter,
                                                                                           java.lang.Integer $top,
                                                                                           java.lang.Integer $skip,
                                                                                           java.lang.String $orderBy)

Retrieve locations for this company

listLocationsByCompany

public FetchResult<LocationModel> listLocationsByCompany(java.lang.Integer companyId,
                                                         java.lang.String $filter,
                                                         java.lang.Integer $top,
                                                         java.lang.Integer $skip,
                                                         java.lang.String $orderBy)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

queryLocationsAsync

public java.util.concurrent.Future<FetchResult<LocationModel>> queryLocationsAsync(java.lang.String $filter,
                                                                                   java.lang.Integer $top,
                                                                                   java.lang.Integer $skip,
                                                                                   java.lang.String $orderBy)

Retrieve all locations

queryLocations

public FetchResult<LocationModel> queryLocations(java.lang.String $filter,
                                                 java.lang.Integer $top,
                                                 java.lang.Integer $skip,
                                                 java.lang.String $orderBy)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

updateLocationAsync

public java.util.concurrent.Future<LocationModel> updateLocationAsync(java.lang.Integer companyId,
                                                                      java.lang.Integer id,
                                                                      LocationModel model)

Update a single location

updateLocation

public LocationModel updateLocation(java.lang.Integer companyId,
                                    java.lang.Integer id,
                                    LocationModel model)
                             throws java.lang.Exception

Throws:

java.lang.Exception

validateLocationAsync

public java.util.concurrent.Future<LocationValidationModel> validateLocationAsync(java.lang.Integer companyId,
                                                                                  java.lang.Integer id)

Validate the location against local requirements

validateLocation

public LocationValidationModel validateLocation(java.lang.Integer companyId,
                                                java.lang.Integer id)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

createNexusAsync

public java.util.concurrent.Future<java.util.ArrayList<NexusModel>> createNexusAsync(java.lang.Integer companyId,
                                                                                     java.util.ArrayList<NexusModel> model)

Create a new nexus

createNexus

public java.util.ArrayList<NexusModel> createNexus(java.lang.Integer companyId,
                                                   java.util.ArrayList<NexusModel> model)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

deleteNexusAsync

public java.util.concurrent.Future<ErrorResult> deleteNexusAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Delete a single nexus

deleteNexus

public ErrorResult deleteNexus(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getNexusAsync

public java.util.concurrent.Future<NexusModel> getNexusAsync(java.lang.Integer companyId,
                                                             java.lang.Integer id)

Retrieve a single nexus

getNexus

public NexusModel getNexus(java.lang.Integer companyId,
                           java.lang.Integer id)
                    throws java.lang.Exception

Throws:

java.lang.Exception

listNexusByCompanyAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> listNexusByCompanyAsync(java.lang.Integer companyId,
                                                                                    java.lang.String $filter,
                                                                                    java.lang.Integer $top,
                                                                                    java.lang.Integer $skip,
                                                                                    java.lang.String $orderBy)

Retrieve nexus for this company

listNexusByCompany

public FetchResult<NexusModel> listNexusByCompany(java.lang.Integer companyId,
                                                  java.lang.String $filter,
                                                  java.lang.Integer $top,
                                                  java.lang.Integer $skip,
                                                  java.lang.String $orderBy)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

queryNexusAsync

public java.util.concurrent.Future<FetchResult<NexusModel>> queryNexusAsync(java.lang.String $filter,
                                                                            java.lang.Integer $top,
                                                                            java.lang.Integer $skip,
                                                                            java.lang.String $orderBy)

Retrieve all nexus

queryNexus

public FetchResult<NexusModel> queryNexus(java.lang.String $filter,
                                          java.lang.Integer $top,
                                          java.lang.Integer $skip,
                                          java.lang.String $orderBy)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

updateNexusAsync

public java.util.concurrent.Future<NexusModel> updateNexusAsync(java.lang.Integer companyId,
                                                                java.lang.Integer id,
                                                                NexusModel model)

Update a single nexus

updateNexus

public NexusModel updateNexus(java.lang.Integer companyId,
                              java.lang.Integer id,
                              NexusModel model)
                       throws java.lang.Exception

Throws:

java.lang.Exception

buildPointOfSaleDataFileAsync

public java.util.concurrent.Future<java.lang.String> buildPointOfSaleDataFileAsync(PointOfSaleDataRequestModel model)

Point of sale data file generation

buildPointOfSaleDataFile

public java.lang.String buildPointOfSaleDataFile(PointOfSaleDataRequestModel model)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

createSettingsAsync

public java.util.concurrent.Future<java.util.ArrayList<SettingModel>> createSettingsAsync(java.lang.Integer companyId,
                                                                                          java.util.ArrayList<SettingModel> model)

Create a new setting

createSettings

public java.util.ArrayList<SettingModel> createSettings(java.lang.Integer companyId,
                                                        java.util.ArrayList<SettingModel> model)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteSettingAsync

public java.util.concurrent.Future<ErrorResult> deleteSettingAsync(java.lang.Integer companyId,
                                                                   java.lang.Integer id)

Delete a single setting

deleteSetting

public ErrorResult deleteSetting(java.lang.Integer companyId,
                                 java.lang.Integer id)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getSettingAsync

public java.util.concurrent.Future<SettingModel> getSettingAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Retrieve a single setting

getSetting

public SettingModel getSetting(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

listSettingsByCompanyAsync

public java.util.concurrent.Future<FetchResult<SettingModel>> listSettingsByCompanyAsync(java.lang.Integer companyId,
                                                                                         java.lang.String $filter,
                                                                                         java.lang.Integer $top,
                                                                                         java.lang.Integer $skip,
                                                                                         java.lang.String $orderBy)

Retrieve all settings for this company

listSettingsByCompany

public FetchResult<SettingModel> listSettingsByCompany(java.lang.Integer companyId,
                                                       java.lang.String $filter,
                                                       java.lang.Integer $top,
                                                       java.lang.Integer $skip,
                                                       java.lang.String $orderBy)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

querySettingsAsync

public java.util.concurrent.Future<FetchResult<SettingModel>> querySettingsAsync(java.lang.String $filter,
                                                                                 java.lang.Integer $top,
                                                                                 java.lang.Integer $skip,
                                                                                 java.lang.String $orderBy)

Retrieve all settings

querySettings

public FetchResult<SettingModel> querySettings(java.lang.String $filter,
                                               java.lang.Integer $top,
                                               java.lang.Integer $skip,
                                               java.lang.String $orderBy)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

updateSettingAsync

public java.util.concurrent.Future<SettingModel> updateSettingAsync(java.lang.Integer companyId,
                                                                    java.lang.Integer id,
                                                                    SettingModel model)

Update a single setting

updateSetting

public SettingModel updateSetting(java.lang.Integer companyId,
                                  java.lang.Integer id,
                                  SettingModel model)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionAsync

public java.util.concurrent.Future<SubscriptionModel> getSubscriptionAsync(java.lang.Integer accountId,
                                                                           java.lang.Integer id)

Retrieve a single subscription

getSubscription

public SubscriptionModel getSubscription(java.lang.Integer accountId,
                                         java.lang.Integer id)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

listSubscriptionsByAccountAsync

public java.util.concurrent.Future<FetchResult<SubscriptionModel>> listSubscriptionsByAccountAsync(java.lang.Integer accountId,
                                                                                                   java.lang.String $filter,
                                                                                                   java.lang.Integer $top,
                                                                                                   java.lang.Integer $skip,
                                                                                                   java.lang.String $orderBy)

Retrieve subscriptions for this account

listSubscriptionsByAccount

public FetchResult<SubscriptionModel> listSubscriptionsByAccount(java.lang.Integer accountId,
                                                                 java.lang.String $filter,
                                                                 java.lang.Integer $top,
                                                                 java.lang.Integer $skip,
                                                                 java.lang.String $orderBy)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

querySubscriptionsAsync

public java.util.concurrent.Future<FetchResult<SubscriptionModel>> querySubscriptionsAsync(java.lang.String $filter,
                                                                                           java.lang.Integer $top,
                                                                                           java.lang.Integer $skip,
                                                                                           java.lang.String $orderBy)

Retrieve all subscriptions

querySubscriptions

public FetchResult<SubscriptionModel> querySubscriptions(java.lang.String $filter,
                                                         java.lang.Integer $top,
                                                         java.lang.Integer $skip,
                                                         java.lang.String $orderBy)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

createTaxCodesAsync

public java.util.concurrent.Future<java.util.ArrayList<TaxCodeModel>> createTaxCodesAsync(java.lang.Integer companyId,
                                                                                          java.util.ArrayList<TaxCodeModel> model)

Create a new tax code

createTaxCodes

public java.util.ArrayList<TaxCodeModel> createTaxCodes(java.lang.Integer companyId,
                                                        java.util.ArrayList<TaxCodeModel> model)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteTaxCodeAsync

public java.util.concurrent.Future<ErrorResult> deleteTaxCodeAsync(java.lang.Integer companyId,
                                                                   java.lang.Integer id)

Delete a single tax code

deleteTaxCode

public ErrorResult deleteTaxCode(java.lang.Integer companyId,
                                 java.lang.Integer id)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getTaxCodeAsync

public java.util.concurrent.Future<TaxCodeModel> getTaxCodeAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Retrieve a single tax code

getTaxCode

public TaxCodeModel getTaxCode(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

listTaxCodesByCompanyAsync

public java.util.concurrent.Future<FetchResult<TaxCodeModel>> listTaxCodesByCompanyAsync(java.lang.Integer companyId,
                                                                                         java.lang.String $filter,
                                                                                         java.lang.Integer $top,
                                                                                         java.lang.Integer $skip,
                                                                                         java.lang.String $orderBy)

Retrieve tax codes for this company

listTaxCodesByCompany

public FetchResult<TaxCodeModel> listTaxCodesByCompany(java.lang.Integer companyId,
                                                       java.lang.String $filter,
                                                       java.lang.Integer $top,
                                                       java.lang.Integer $skip,
                                                       java.lang.String $orderBy)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

queryTaxCodesAsync

public java.util.concurrent.Future<FetchResult<TaxCodeModel>> queryTaxCodesAsync(java.lang.String $filter,
                                                                                 java.lang.Integer $top,
                                                                                 java.lang.Integer $skip,
                                                                                 java.lang.String $orderBy)

Retrieve all tax codes

queryTaxCodes

public FetchResult<TaxCodeModel> queryTaxCodes(java.lang.String $filter,
                                               java.lang.Integer $top,
                                               java.lang.Integer $skip,
                                               java.lang.String $orderBy)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

updateTaxCodeAsync

public java.util.concurrent.Future<TaxCodeModel> updateTaxCodeAsync(java.lang.Integer companyId,
                                                                    java.lang.Integer id,
                                                                    TaxCodeModel model)

Update a single tax code

updateTaxCode

public TaxCodeModel updateTaxCode(java.lang.Integer companyId,
                                  java.lang.Integer id,
                                  TaxCodeModel model)
                           throws java.lang.Exception

Throws:

java.lang.Exception

taxRatesByAddressAsync

public java.util.concurrent.Future<TaxRateModel> taxRatesByAddressAsync(java.lang.String line1,
                                                                        java.lang.String line2,
                                                                        java.lang.String line3,
                                                                        java.lang.String city,
                                                                        java.lang.String region,
                                                                        java.lang.String postalCode,
                                                                        java.lang.String country)

Retrieve tax rates for a specified address

taxRatesByAddress

public TaxRateModel taxRatesByAddress(java.lang.String line1,
                                      java.lang.String line2,
                                      java.lang.String line3,
                                      java.lang.String city,
                                      java.lang.String region,
                                      java.lang.String postalCode,
                                      java.lang.String country)
                               throws java.lang.Exception

Throws:

java.lang.Exception

taxRatesByPostalCodeAsync

public java.util.concurrent.Future<TaxRateModel> taxRatesByPostalCodeAsync(java.lang.String country,
                                                                           java.lang.String postalCode)

Retrieve tax rates for a specified country and postal code

taxRatesByPostalCode

public TaxRateModel taxRatesByPostalCode(java.lang.String country,
                                         java.lang.String postalCode)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

createTaxRulesAsync

public java.util.concurrent.Future<java.util.ArrayList<TaxRuleModel>> createTaxRulesAsync(java.lang.Integer companyId,
                                                                                          java.util.ArrayList<TaxRuleModel> model)

Create a new tax rule

createTaxRules

public java.util.ArrayList<TaxRuleModel> createTaxRules(java.lang.Integer companyId,
                                                        java.util.ArrayList<TaxRuleModel> model)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteTaxRuleAsync

public java.util.concurrent.Future<ErrorResult> deleteTaxRuleAsync(java.lang.Integer companyId,
                                                                   java.lang.Integer id)

Delete a single tax rule

deleteTaxRule

public ErrorResult deleteTaxRule(java.lang.Integer companyId,
                                 java.lang.Integer id)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getTaxRuleAsync

public java.util.concurrent.Future<TaxRuleModel> getTaxRuleAsync(java.lang.Integer companyId,
                                                                 java.lang.Integer id)

Retrieve a single tax rule

getTaxRule

public TaxRuleModel getTaxRule(java.lang.Integer companyId,
                               java.lang.Integer id)
                        throws java.lang.Exception

Throws:

java.lang.Exception

listTaxRulesAsync

public java.util.concurrent.Future<FetchResult<TaxRuleModel>> listTaxRulesAsync(java.lang.Integer companyId,
                                                                                java.lang.String $filter,
                                                                                java.lang.Integer $top,
                                                                                java.lang.Integer $skip,
                                                                                java.lang.String $orderBy)

Retrieve tax rules for this company

listTaxRules

public FetchResult<TaxRuleModel> listTaxRules(java.lang.Integer companyId,
                                              java.lang.String $filter,
                                              java.lang.Integer $top,
                                              java.lang.Integer $skip,
                                              java.lang.String $orderBy)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

queryTaxRulesAsync

public java.util.concurrent.Future<FetchResult<TaxRuleModel>> queryTaxRulesAsync(java.lang.String $filter,
                                                                                 java.lang.Integer $top,
                                                                                 java.lang.Integer $skip,
                                                                                 java.lang.String $orderBy)

Retrieve all tax rules

queryTaxRules

public FetchResult<TaxRuleModel> queryTaxRules(java.lang.String $filter,
                                               java.lang.Integer $top,
                                               java.lang.Integer $skip,
                                               java.lang.String $orderBy)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

updateTaxRuleAsync

public java.util.concurrent.Future<TaxRuleModel> updateTaxRuleAsync(java.lang.Integer companyId,
                                                                    java.lang.Integer id,
                                                                    TaxRuleModel model)

Update a single tax rule

updateTaxRule

public TaxRuleModel updateTaxRule(java.lang.Integer companyId,
                                  java.lang.Integer id,
                                  TaxRuleModel model)
                           throws java.lang.Exception

Throws:

java.lang.Exception

adjustTransactionAsync

public java.util.concurrent.Future<TransactionModel> adjustTransactionAsync(java.lang.String companyCode,
                                                                            java.lang.String transactionCode,
                                                                            AdjustTransactionModel model)

Correct a previously created transaction

adjustTransaction

public TransactionModel adjustTransaction(java.lang.String companyCode,
                                          java.lang.String transactionCode,
                                          AdjustTransactionModel model)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

changeTransactionCodeAsync

public java.util.concurrent.Future<TransactionModel> changeTransactionCodeAsync(java.lang.String companyCode,
                                                                                java.lang.String transactionCode,
                                                                                ChangeTransactionCodeModel model)

Change a transaction's code

changeTransactionCode

public TransactionModel changeTransactionCode(java.lang.String companyCode,
                                              java.lang.String transactionCode,
                                              ChangeTransactionCodeModel model)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

commitTransactionAsync

public java.util.concurrent.Future<TransactionModel> commitTransactionAsync(java.lang.String companyCode,
                                                                            java.lang.String transactionCode,
                                                                            CommitTransactionModel model)

Commit a transaction for reporting

commitTransaction

public TransactionModel commitTransaction(java.lang.String companyCode,
                                          java.lang.String transactionCode,
                                          CommitTransactionModel model)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

createTransactionAsync

public java.util.concurrent.Future<TransactionModel> createTransactionAsync(CreateTransactionModel model)

Create a new transaction

createTransaction

public TransactionModel createTransaction(CreateTransactionModel model)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getTransactionByCodeAsync

public java.util.concurrent.Future<TransactionModel> getTransactionByCodeAsync(java.lang.String companyCode,
                                                                               java.lang.String transactionCode,
                                                                               java.lang.String $include)

Retrieve a single transaction by code

getTransactionByCode

public TransactionModel getTransactionByCode(java.lang.String companyCode,
                                             java.lang.String transactionCode,
                                             java.lang.String $include)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTransactionByIdAsync

public java.util.concurrent.Future<TransactionModel> getTransactionByIdAsync(java.lang.Long id,
                                                                             java.lang.String $include)

Retrieve a single transaction by ID

getTransactionById

public TransactionModel getTransactionById(java.lang.Long id,
                                           java.lang.String $include)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

listTransactionsByCompanyAsync

public java.util.concurrent.Future<FetchResult<TransactionModel>> listTransactionsByCompanyAsync(java.lang.String companyCode,
                                                                                                 java.lang.String $include,
                                                                                                 java.lang.String $filter,
                                                                                                 java.lang.Integer $top,
                                                                                                 java.lang.Integer $skip,
                                                                                                 java.lang.String $orderBy)

Retrieve all transactions

listTransactionsByCompany

public FetchResult<TransactionModel> listTransactionsByCompany(java.lang.String companyCode,
                                                               java.lang.String $include,
                                                               java.lang.String $filter,
                                                               java.lang.Integer $top,
                                                               java.lang.Integer $skip,
                                                               java.lang.String $orderBy)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

settleTransactionAsync

public java.util.concurrent.Future<TransactionModel> settleTransactionAsync(java.lang.String companyCode,
                                                                            java.lang.String transactionCode,
                                                                            SettleTransactionModel model)

Perform multiple actions on a transaction

settleTransaction

public TransactionModel settleTransaction(java.lang.String companyCode,
                                          java.lang.String transactionCode,
                                          SettleTransactionModel model)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

verifyTransactionAsync

public java.util.concurrent.Future<TransactionModel> verifyTransactionAsync(java.lang.String companyCode,
                                                                            java.lang.String transactionCode,
                                                                            VerifyTransactionModel model)

Verify a transaction

verifyTransaction

public TransactionModel verifyTransaction(java.lang.String companyCode,
                                          java.lang.String transactionCode,
                                          VerifyTransactionModel model)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

voidTransactionAsync

public java.util.concurrent.Future<TransactionModel> voidTransactionAsync(java.lang.String companyCode,
                                                                          java.lang.String transactionCode,
                                                                          VoidTransactionModel model)

Void a transaction

voidTransaction

public TransactionModel voidTransaction(java.lang.String companyCode,
                                        java.lang.String transactionCode,
                                        VoidTransactionModel model)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

createUPCsAsync

public java.util.concurrent.Future<java.util.ArrayList<UPCModel>> createUPCsAsync(java.lang.Integer companyId,
                                                                                  java.util.ArrayList<UPCModel> model)

Create a new UPC

createUPCs

public java.util.ArrayList<UPCModel> createUPCs(java.lang.Integer companyId,
                                                java.util.ArrayList<UPCModel> model)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

deleteUPCAsync

public java.util.concurrent.Future<ErrorResult> deleteUPCAsync(java.lang.Integer companyId,
                                                               java.lang.Integer id)

Delete a single UPC

deleteUPC

public ErrorResult deleteUPC(java.lang.Integer companyId,
                             java.lang.Integer id)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getUPCAsync

public java.util.concurrent.Future<UPCModel> getUPCAsync(java.lang.Integer companyId,
                                                         java.lang.Integer id)

Retrieve a single UPC

getUPC

public UPCModel getUPC(java.lang.Integer companyId,
                       java.lang.Integer id)
                throws java.lang.Exception

Throws:

java.lang.Exception

listUPCsByCompanyAsync

public java.util.concurrent.Future<FetchResult<UPCModel>> listUPCsByCompanyAsync(java.lang.Integer companyId,
                                                                                 java.lang.String $filter,
                                                                                 java.lang.Integer $top,
                                                                                 java.lang.Integer $skip,
                                                                                 java.lang.String $orderBy)

Retrieve UPCs for this company

listUPCsByCompany

public FetchResult<UPCModel> listUPCsByCompany(java.lang.Integer companyId,
                                               java.lang.String $filter,
                                               java.lang.Integer $top,
                                               java.lang.Integer $skip,
                                               java.lang.String $orderBy)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

queryUPCsAsync

public java.util.concurrent.Future<FetchResult<UPCModel>> queryUPCsAsync(java.lang.String $filter,
                                                                         java.lang.Integer $top,
                                                                         java.lang.Integer $skip,
                                                                         java.lang.String $orderBy)

Retrieve all UPCs

queryUPCs

public FetchResult<UPCModel> queryUPCs(java.lang.String $filter,
                                       java.lang.Integer $top,
                                       java.lang.Integer $skip,
                                       java.lang.String $orderBy)
                                throws java.lang.Exception

Throws:

java.lang.Exception

updateUPCAsync

public java.util.concurrent.Future<UPCModel> updateUPCAsync(java.lang.Integer companyId,
                                                            java.lang.Integer id,
                                                            UPCModel model)

Update a single UPC

updateUPC

public UPCModel updateUPC(java.lang.Integer companyId,
                          java.lang.Integer id,
                          UPCModel model)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getUserAsync

public java.util.concurrent.Future<UserModel> getUserAsync(java.lang.Integer id,
                                                           java.lang.Integer accountId,
                                                           java.lang.String $include)

Retrieve a single user

getUser

public UserModel getUser(java.lang.Integer id,
                         java.lang.Integer accountId,
                         java.lang.String $include)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getUserEntitlementsAsync

public java.util.concurrent.Future<UserEntitlementModel> getUserEntitlementsAsync(java.lang.Integer id,
                                                                                  java.lang.Integer accountId)

Retrieve all entitlements for a single user

getUserEntitlements

public UserEntitlementModel getUserEntitlements(java.lang.Integer id,
                                                java.lang.Integer accountId)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

listUsersByAccountAsync

public java.util.concurrent.Future<FetchResult<UserModel>> listUsersByAccountAsync(java.lang.Integer accountId,
                                                                                   java.lang.String $include,
                                                                                   java.lang.String $filter,
                                                                                   java.lang.Integer $top,
                                                                                   java.lang.Integer $skip,
                                                                                   java.lang.String $orderBy)

Retrieve users for this account

listUsersByAccount

public FetchResult<UserModel> listUsersByAccount(java.lang.Integer accountId,
                                                 java.lang.String $include,
                                                 java.lang.String $filter,
                                                 java.lang.Integer $top,
                                                 java.lang.Integer $skip,
                                                 java.lang.String $orderBy)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

queryUsersAsync

public java.util.concurrent.Future<FetchResult<UserModel>> queryUsersAsync(java.lang.String $include,
                                                                           java.lang.String $filter,
                                                                           java.lang.Integer $top,
                                                                           java.lang.Integer $skip,
                                                                           java.lang.String $orderBy)

Retrieve all users

queryUsers

public FetchResult<UserModel> queryUsers(java.lang.String $include,
                                         java.lang.String $filter,
                                         java.lang.Integer $top,
                                         java.lang.Integer $skip,
                                         java.lang.String $orderBy)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

updateUserAsync

public java.util.concurrent.Future<UserModel> updateUserAsync(java.lang.Integer id,
                                                              java.lang.Integer accountId,
                                                              UserModel model)

Update a single user

updateUser

public UserModel updateUser(java.lang.Integer id,
                            java.lang.Integer accountId,
                            UserModel model)
                     throws java.lang.Exception

Throws:

java.lang.Exception

getMySubscriptionAsync

public java.util.concurrent.Future<SubscriptionModel> getMySubscriptionAsync(java.lang.String serviceTypeId)

Checks if the current user is subscribed to a specific service

getMySubscription

public SubscriptionModel getMySubscription(java.lang.String serviceTypeId)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

listMySubscriptionsAsync

public java.util.concurrent.Future<SubscriptionModel> listMySubscriptionsAsync()

List all services to which the current user is subscribed

listMySubscriptions

public SubscriptionModel listMySubscriptions()
                                      throws java.lang.Exception

Throws:

java.lang.Exception

pingAsync

public java.util.concurrent.Future<PingResultModel> pingAsync()

Tests connectivity and version of the service

ping

public PingResultModel ping()
                     throws java.lang.Exception

Throws:

java.lang.Exception