avatax 17.7.3 → 17.8.1

data/lib/avatax/client/filings.rb

@@ -16,7 +16,7 @@ module AvaTax
       # @param year [Integer] The year of the filing period to approve.
       # @param month [Integer] The month of the filing period to approve.
       # @param model [Object] The approve request you wish to execute.
-      # @return [object[]]
+      # @return [FilingModel[]]
       def approve_filings(companyId, year, month, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/approve"
         post(path, model)
@@ -37,7 +37,7 @@ module AvaTax
       # @param month [Integer] The month of the filing period to approve.
       # @param country [String] The two-character ISO-3166 code for the country.
       # @param model [Object] The approve request you wish to execute.
-      # @return [object[]]
+      # @return [FilingModel[]]
       def approve_filings_country(companyId, year, month, country, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/approve"
         post(path, model)
@@ -59,7 +59,7 @@ module AvaTax
       # @param country [String] The two-character ISO-3166 code for the country.
       # @param region [String] The two or three character region code for the region.
       # @param model [Object] The approve request you wish to execute.
-      # @return [object[]]
+      # @return [FilingModel[]]
       def approve_filings_country_region(companyId, year, month, country, region, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/approve"
         post(path, model)
@@ -80,8 +80,8 @@ module AvaTax
       # @param country [String] The two-character ISO-3166 code for the country of the filing being adjusted.
       # @param region [String] The two or three character region code for the region.
       # @param formCode [String] The unique code of the form being adjusted.
-      # @param model [object[]] A list of Adjustments to be created for the specified filing.
-      # @return [object[]]
+      # @param model [FilingAdjustmentModel[]] A list of Adjustments to be created for the specified filing.
+      # @return [FilingAdjustmentModel[]]
       def create_return_adjustment(companyId, year, month, country, region, formCode, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/adjust"
         post(path, model)
@@ -101,8 +101,8 @@ module AvaTax
       # @param country [String] The two-character ISO-3166 code for the country of the filing being changed.
       # @param region [String] The two or three character region code for the region of the filing being changed.
       # @param formCode [String] The unique code of the form being changed.
-      # @param model [object[]] A list of augmentations to be created for the specified filing.
-      # @return [object[]]
+      # @param model [FilingAugmentationModel[]] A list of augmentations to be created for the specified filing.
+      # @return [FilingAugmentationModel[]]
       def create_return_augmentation(companyId, year, month, country, region, formCode, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/augment"
         post(path, model)
@@ -123,8 +123,8 @@ module AvaTax
       # @param country [String] The two-character ISO-3166 code for the country of the filing being adjusted.
       # @param region [String] The two or three character region code for the region.
       # @param formCode [String] The unique code of the form being adjusted.
-      # @param model [object[]] A list of Payments to be created for the specified filing.
-      # @return [object[]]
+      # @param model [FilingPaymentModel[]] A list of Payments to be created for the specified filing.
+      # @return [FilingPaymentModel[]]
       def create_return_payment(companyId, year, month, country, region, formCode, model)
         path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/payment"
         post(path, model)
@@ -141,7 +141,7 @@ module AvaTax
       # This API can only be used when the filing has been unapproved.
       # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
       # @param id [Integer] The ID of the adjustment being deleted.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_return_adjustment(companyId, id)
         path = "/api/v2/companies/#{companyId}/filings/adjust/#{id}"
         delete(path)
@@ -157,7 +157,7 @@ module AvaTax
       # This API can only be used when the filing has been unapproved.
       # @param companyId [Integer] The ID of the company that owns the filing being changed.
       # @param id [Integer] The ID of the augmentation being added.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_return_augmentation(companyId, id)
         path = "/api/v2/companies/#{companyId}/filings/augment/#{id}"
         delete(path)
@@ -174,7 +174,7 @@ module AvaTax
       # This API can only be used when the filing has been unapproved.
       # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
       # @param id [Integer] The ID of the payment being deleted.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_return_payment(companyId, id)
         path = "/api/v2/companies/#{companyId}/filings/payment/#{id}"
         delete(path)

data/lib/avatax/client/items.rb

@@ -7,8 +7,8 @@ module AvaTax
       #
       # Creates one or more new item objects attached to this company.
       # @param companyId [Integer] The ID of the company that owns this item.
-      # @param model [object[]] The item you wish to create.
-      # @return [object[]]
+      # @param model [ItemModel[]] The item you wish to create.
+      # @return [ItemModel[]]
       def create_items(companyId, model)
         path = "/api/v2/companies/#{companyId}/items"
         post(path, model)
@@ -20,7 +20,7 @@ module AvaTax
       # Marks the item object at this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param id [Integer] The ID of the item you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_item(companyId, id)
         path = "/api/v2/companies/#{companyId}/items/#{id}"
         delete(path)
@@ -50,7 +50,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that defined these items
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -69,7 +69,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -12,8 +12,8 @@ module AvaTax
       # between two different jurisdictions, you can choose to set up a jurisdiction override
       # to switch this address to use different taxing jurisdictions.
       # @param accountId [Integer] The ID of the account that owns this override
-      # @param model [object[]] The jurisdiction override objects to create
-      # @return [object[]]
+      # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
+      # @return [JurisdictionOverrideModel[]]
       def create_jurisdiction_overrides(accountId, model)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
         post(path, model)
@@ -25,7 +25,7 @@ module AvaTax
       # Marks the item object at this URL as deleted.
       # @param accountId [Integer] The ID of the account that owns this override
       # @param id [Integer] The ID of the override you wish to delete
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_jurisdiction_override(accountId, id)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
         delete(path)
@@ -62,7 +62,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param accountId [Integer] The ID of the account that owns this override
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -85,7 +85,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/locations.rb

@@ -7,8 +7,8 @@ module AvaTax
       #
       # Create one or more new location objects attached to this company.
       # @param companyId [Integer] The ID of the company that owns this location.
-      # @param model [object[]] The location you wish to create.
-      # @return [object[]]
+      # @param model [LocationModel[]] The location you wish to create.
+      # @return [LocationModel[]]
       def create_locations(companyId, model)
         path = "/api/v2/companies/#{companyId}/locations"
         post(path, model)
@@ -20,7 +20,7 @@ module AvaTax
       # Mark the location object at this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this location.
       # @param id [Integer] The ID of the location you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_location(companyId, id)
         path = "/api/v2/companies/#{companyId}/locations/#{id}"
         delete(path)
@@ -40,7 +40,7 @@ module AvaTax
       # * LocationSettings
       # @param companyId [Integer] The ID of the company that owns this location
       # @param id [Integer] The primary key of this location
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
       # @return [Object]
       def get_location(companyId, id, options={})
         path = "/api/v2/companies/#{companyId}/locations/#{id}"
@@ -63,7 +63,7 @@ module AvaTax
       # * LocationSettings
       # @param companyId [Integer] The ID of the company that owns these locations
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -89,7 +89,7 @@ module AvaTax
       #
       # * LocationSettings
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/nexus.rb

@@ -14,8 +14,8 @@ module AvaTax
       # '/api/v2/definitions/nexus' endpoint.
       # You may only define nexus matching the official list of declared nexus.
       # @param companyId [Integer] The ID of the company that owns this nexus.
-      # @param model [object[]] The nexus you wish to create.
-      # @return [object[]]
+      # @param model [NexusModel[]] The nexus you wish to create.
+      # @return [NexusModel[]]
       def create_nexus(companyId, model)
         path = "/api/v2/companies/#{companyId}/nexus"
         post(path, model)
@@ -27,7 +27,7 @@ module AvaTax
       # Marks the existing nexus object at this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param id [Integer] The ID of the nexus you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_nexus(companyId, id)
         path = "/api/v2/companies/#{companyId}/nexus/#{id}"
         delete(path)
@@ -84,7 +84,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these nexus objects
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -106,7 +106,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/notices.rb

@@ -11,8 +11,8 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param id [Integer] The ID of the tax notice we are adding the comment for.
-      # @param model [object[]] The notice comments you wish to create.
-      # @return [object[]]
+      # @param model [NoticeCommentModel[]] The notice comments you wish to create.
+      # @return [NoticeCommentModel[]]
       def create_notice_comment(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
         post(path, model)
@@ -28,8 +28,8 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param id [Integer] The ID of the notice added to the finance details.
-      # @param model [object[]] The notice finance details you wish to create.
-      # @return [object[]]
+      # @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
+      # @return [NoticeFinanceModel[]]
       def create_notice_finance_details(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
         post(path, model)
@@ -44,8 +44,8 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [object[]] The notice responsibilities you wish to create.
-      # @return [object[]]
+      # @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
+      # @return [NoticeResponsibilityDetailModel[]]
       def create_notice_responsibilities(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
         post(path, model)
@@ -60,8 +60,8 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [object[]] The notice root causes you wish to create.
-      # @return [object[]]
+      # @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
+      # @return [NoticeRootCauseDetailModel[]]
       def create_notice_root_causes(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
         post(path, model)
@@ -75,8 +75,8 @@ module AvaTax
       # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param model [object[]] The notice object you wish to create.
-      # @return [object[]]
+      # @param model [NoticeModel[]] The notice object you wish to create.
+      # @return [NoticeModel[]]
       def create_notices(companyId, model)
         path = "/api/v2/companies/#{companyId}/notices"
         post(path, model)
@@ -91,7 +91,7 @@ module AvaTax
       # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param id [Integer] The ID of the notice you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_notice(companyId, id)
         path = "/api/v2/companies/#{companyId}/notices/#{id}"
         delete(path)
@@ -107,7 +107,7 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param noticeId [Integer] The ID of the notice you wish to delete.
       # @param id [Integer] The ID of the responsibility you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_responsibilities(companyId, noticeId, id)
         path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
         delete(path)
@@ -123,7 +123,7 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this notice.
       # @param noticeId [Integer] The ID of the notice you wish to delete.
       # @param id [Integer] The ID of the root cause you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_root_causes(companyId, noticeId, id)
         path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
         delete(path)
@@ -230,7 +230,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these notices.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -251,7 +251,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

data/lib/avatax/client/onboarding.rb

@@ -6,9 +6,19 @@ module AvaTax
       # Request a new Avalara account
       #
       # This API is for use by partner onboarding services customers only.
+      #
+      # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
+      # of AvaTax. These partners can create accounts for new customers using this API.
+      #
       # Calling this API creates an account with the specified product subscriptions, but does not configure billing.
       # The customer will receive information from Avalara about how to configure billing for their account.
       # You should call this API when a customer has requested to begin using Avalara services.
+      #
+      # If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara
+      # terms and conditions. If they do so, they can receive a license key as part of this API and their
+      # API will be created in `Active` status. If the customer has not yet read and accepted these terms and
+      # conditions, the account will be created in `New` status and they can receive a license key by logging
+      # onto AvaTax and reviewing terms and conditions online.
       # @param model [Object] Information about the account you wish to create and the selected product offerings.
       # @return [Object]
       def request_new_account(model)

data/lib/avatax/client/registrar.rb

@@ -43,8 +43,8 @@ module AvaTax
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
       # @param accountId [Integer] The ID of the account that owns this subscription.
-      # @param model [object[]] The subscription you wish to create.
-      # @return [object[]]
+      # @param model [SubscriptionModel[]] The subscription you wish to create.
+      # @return [SubscriptionModel[]]
       def create_subscriptions(accountId, model)
         path = "/api/v2/accounts/#{accountId}/subscriptions"
         post(path, model)
@@ -59,8 +59,8 @@ module AvaTax
       # Create one or more new user objects attached to this account.
       # A user represents one person with access privileges to make API calls and work with a specific account.
       # @param accountId [Integer] The unique ID number of the account where these users will be created.
-      # @param model [object[]] The user or array of users you wish to create.
-      # @return [object[]]
+      # @param model [UserModel[]] The user or array of users you wish to create.
+      # @return [UserModel[]]
       def create_users(accountId, model)
         path = "/api/v2/accounts/#{accountId}/users"
         post(path, model)
@@ -75,7 +75,7 @@ module AvaTax
       # Delete an account.
       # Deleting an account will delete all companies and all account level users attached to this account.
       # @param id [Integer] The ID of the account you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_account(id)
         path = "/api/v2/accounts/#{id}"
         delete(path)
@@ -90,7 +90,7 @@ module AvaTax
       # Mark the existing account identified by this URL as deleted.
       # @param accountId [Integer] The ID of the account that owns this subscription.
       # @param id [Integer] The ID of the subscription you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_subscription(accountId, id)
         path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
         delete(path)
@@ -105,7 +105,7 @@ module AvaTax
       # Mark the user object identified by this URL as deleted.
       # @param id [Integer] The ID of the user you wish to delete.
       # @param accountId [Integer] The accountID of the user you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_user(id, accountId)
         path = "/api/v2/accounts/#{accountId}/users/#{id}"
         delete(path)
@@ -126,7 +126,7 @@ module AvaTax
       # * Users
       #
       # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

data/lib/avatax/client/reports.rb

@@ -0,0 +1,19 @@
+module AvaTax
+  class Client
+    module Reports 
+
+
+      # Export a report accurate to the line level
+      #
+      # 
+      # @param companyId [Integer] 
+      # @param model [Object] 
+      # @return [Object]
+      def export_document_line(companyId, model)
+        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline"
+        post(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/settings.rb

@@ -13,8 +13,8 @@ module AvaTax
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
       # @param companyId [Integer] The ID of the company that owns this setting.
-      # @param model [object[]] The setting you wish to create.
-      # @return [object[]]
+      # @param model [SettingModel[]] The setting you wish to create.
+      # @return [SettingModel[]]
       def create_settings(companyId, model)
         path = "/api/v2/companies/#{companyId}/settings"
         post(path, model)
@@ -26,7 +26,7 @@ module AvaTax
       # Mark the setting object at this URL as deleted.
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param id [Integer] The ID of the setting you wish to delete.
-      # @return [object[]]
+      # @return [ErrorDetail[]]
       def delete_setting(companyId, id)
         path = "/api/v2/companies/#{companyId}/settings/#{id}"
         delete(path)
@@ -65,7 +65,7 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these settings
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -89,7 +89,7 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.