avatax 14.4.4 → 17.5.0

data/lib/avatax/client/filingcalendars.rb

@@ -0,0 +1,313 @@
+module AvaTax
+  class Client
+    module FilingCalendars 
+
+
+      # Retrieve a single filing calendar
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The ID of the company that owns this filing calendar
+      # @param int id The primary key of this filing calendar
+      # @return FilingCalendarModel
+      def api_v2_companies_by_company_id_filingcalendars_by_id_get(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve all filing calendars for this company
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The ID of the company that owns these batches
+      # @param string filter 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 int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def api_v2_companies_by_company_id_filingcalendars_get(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/filingcalendars"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all filing requests for this company
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The ID of the company that owns these batches
+      # @param string filter 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 int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def api_v2_companies_by_company_id_filingrequests_get(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/filingrequests"
+        
+        get(path, options)
+      end
+
+
+      # Returns a list of options for adding the specified form.
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing calendar object
+      # @param string formCode The unique code of the form
+      # @return CycleAddOptionModel[]
+      def cycle_safe_add(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/filingcalendars/add/options"
+        
+        get(path, options)
+      end
+
+
+      # Indicates when changes are allowed to be made to a filing calendar.
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing calendar object
+      # @param int id The unique ID of the filing calendar object
+      # @param FilingCalendarEditModel[] model A list of filing calendar edits to be made
+      # @return CycleEditOptionModel
+      def cycle_safe_edit(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/options"
+        
+        post(path, model)
+      end
+
+
+      # Returns a list of options for expiring a filing calendar
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing calendar object
+      # @param int id The unique ID of the filing calendar object
+      # @return CycleExpireModel
+      def cycle_safe_expiration(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/options"
+        
+        get(path)
+      end
+
+
+      # Delete a single filing calendar.
+      # 
+      # This API is available by invitation only.
+      # Mark the existing notice object at this URL as deleted.
+      # 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 int companyId The ID of the company that owns this filing calendar.
+      # @param int id The ID of the filing calendar you wish to delete.
+      # @return ErrorDetail[]
+      def delete_filing_calendar(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Edit existing Filing Calendar's Notes
+      # 
+      # This API is available by invitation only.
+      # This API only allows updating of internal notes and company filing instructions.
+      # All other updates must go through a filing request at this time.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing request object
+      # @param int id The unique ID of the filing calendar object
+      # @param FilingCalendarModel model The filing calendar model you are wishing to update with.
+      # @return FilingCalendarModel
+      def filing_calendar_update(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
+        
+        put(path, model)
+      end
+
+
+      # Retrieve a single filing request
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The ID of the company that owns this filing calendar
+      # @param int id The primary key of this filing calendar
+      # @return FilingRequestModel
+      def filing_requests(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
+        
+        get(path)
+      end
+
+
+      # Create a new filing request to create a filing calendar
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The unique ID of the company that will add the new filing calendar
+      # @param FilingRequestModel[] model Information about the proposed new filing calendar
+      # @return FilingRequestModel
+      def filing_requests_add(companyId, model)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/add/request"
+        
+        post(path, model)
+      end
+
+
+      # Approve existing Filing Request
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # The filing request must be in the "ChangeRequest" status to be approved.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing request object
+      # @param int id The unique ID of the filing request object
+      # @return FilingRequestModel
+      def filing_requests_approve(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/approve"
+        
+        post(path)
+      end
+
+
+      # Cancel existing Filing Request
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing request object
+      # @param int id The unique ID of the filing request object
+      # @return FilingRequestModel
+      def filing_requests_cancel(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/cancel"
+        
+        post(path)
+      end
+
+
+      # Create a new filing request to cancel a filing calendar
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing calendar object
+      # @param int id The unique ID number of the filing calendar to cancel
+      # @param FilingRequestModel[] model The cancellation request for this filing calendar
+      # @return FilingRequestModel
+      def filing_requests_new_cancel(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/request"
+        
+        post(path, model)
+      end
+
+
+      # Create a new filing request to edit a filing calendar
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing calendar object
+      # @param int id The unique ID number of the filing calendar to edit
+      # @param FilingRequestModel[] model A list of filing calendar edits to be made
+      # @return FilingRequestModel
+      def filing_requests_new_edit(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/request"
+        
+        post(path, model)
+      end
+
+
+      # Edit existing Filing Request
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # @param int companyId The unique ID of the company that owns the filing request object
+      # @param int id The unique ID of the filing request object
+      # @param FilingRequestModel model A list of filing calendar edits to be made
+      # @return FilingRequestModel
+      def filing_requests_update(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
+        
+        put(path, model)
+      end
+
+
+      # Gets the request status and Login Result
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int jobId The unique ID number of this login request
+      # @return LoginVerificationOutputModel
+      def login_verification_get(jobId)
+        path = "/api/v2/filingcalendars/credentials/#{jobId}"
+        
+        get(path)
+      end
+
+
+      # New request for getting for validating customer's login credentials
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param LoginVerificationInputModel model The model of the login information we are verifying
+      # @return LoginVerificationOutputModel
+      def login_verification_post(model)
+        path = "/api/v2/filingcalendars/credentials/verify"
+        
+        post(path, model)
+      end
+
+
+      # Retrieve all filing calendars
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param string filter 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 int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def query_filing_calendars(options={})
+        path = "/api/v2/filingcalendars"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all filing requests
+      # 
+      # This API is available by invitation only.
+      # A "filing request" represents a request to change an existing filing calendar. Filing requests
+      # are reviewed and validated by Avalara Compliance before being implemented.
+      # 
+      # 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 string filter 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 int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def query_filing_requests(options={})
+        path = "/api/v2/filingrequests"
+        
+        get(path, options)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/filings.rb

@@ -0,0 +1,417 @@
+module AvaTax
+  class Client
+    module Filings 
+
+
+      # Approve all filings for the specified company in the given filing period.
+      # 
+      # This API is available by invitation only.
+      # Approving a return means the customer is ready to let Avalara file that return.
+      # Customer either approves themselves from admin console, 
+      # else system auto-approves the night before the filing cycle.
+      # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to approve.
+      # @param int month The month of the filing period to approve.
+      # @param ApproveFilingsModel model The approve request you wish to execute.
+      # @return FilingModel[]
+      def approve_filings(companyId, year, month, model)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/approve"
+        
+        post(path, model)
+      end
+
+
+      # Approve all filings for the specified company in the given filing period and country.
+      # 
+      # This API is available by invitation only.
+      # Approving a return means the customer is ready to let Avalara file that return.
+      # Customer either approves themselves from admin console, 
+      # else system auto-approves the night before the filing cycle.
+      # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to approve.
+      # @param int month The month of the filing period to approve.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param ApproveFilingsModel model The approve request you wish to execute.
+      # @return FilingModel[]
+      def approve_filings_country(companyId, year, month, country, model)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/approve"
+        
+        post(path, model)
+      end
+
+
+      # Approve all filings for the specified company in the given filing period, country and region.
+      # 
+      # This API is available by invitation only.
+      # Approving a return means the customer is ready to let Avalara file that return.
+      # Customer either approves themselves from admin console, 
+      # else system auto-approves the night before the filing cycle
+      # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to approve.
+      # @param int month The month of the filing period to approve.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param string region The two or three character region code for the region.
+      # @param ApproveFilingsModel model The approve request you wish to execute.
+      # @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)
+      end
+
+
+      # Add an adjustment to a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
+      # such as early filer discount amounts that are refunded to the customer, or efile fees from websites. 
+      # Sometimes may be a manual change in tax liability similar to an augmentation.
+      # This API creates a new adjustment for an existing tax filing.
+      # This API can only be used when the filing has not yet been approved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being adjusted.
+      # @param int year The year of the filing's filing period being adjusted.
+      # @param int month The month of the filing's filing period being adjusted.
+      # @param string country The two-character ISO-3166 code for the country of the filing being adjusted.
+      # @param string region The two or three character region code for the region.
+      # @param string formCode The unique code of the form being adjusted.
+      # @param FilingAdjustmentModel[] model 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)
+      end
+
+
+      # Add an augmentation for a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara 
+      # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
+      # This API creates a new augmentation for an existing tax filing.
+      # This API can only be used when the filing has not been approved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being changed.
+      # @param int year The month of the filing's filing period being changed.
+      # @param int month The month of the filing's filing period being changed.
+      # @param string country The two-character ISO-3166 code for the country of the filing being changed.
+      # @param string region The two or three character region code for the region of the filing being changed.
+      # @param string formCode The unique code of the form being changed.
+      # @param FilingAugmentationModel[] model 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)
+      end
+
+
+      # Delete an adjustment for a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
+      # such as early filer discount amounts that are refunded to the customer, or efile fees from websites. 
+      # Sometimes may be a manual change in tax liability similar to an augmentation.
+      # This API deletes an adjustment for an existing tax filing.
+      # This API can only be used when the filing has been unapproved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being adjusted.
+      # @param int id The ID of the adjustment being deleted.
+      # @return ErrorDetail[]
+      def delete_return_adjustment(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filings/adjust/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Delete an augmentation for a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara 
+      # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
+      # This API deletes an augmentation for an existing tax filing.
+      # This API can only be used when the filing has been unapproved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being changed.
+      # @param int id The ID of the augmentation being added.
+      # @return ErrorDetail[]
+      def delete_return_augmentation(companyId, id)
+        path = "/api/v2/companies/#{companyId}/filings/augment/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve worksheet checkup report for company and filing period.
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int worksheetId The unique id of the worksheet.
+      # @param int companyId The unique ID of the company that owns the worksheet.
+      # @return FilingsCheckupModel
+      def filings_checkup_report(worksheetId, companyId)
+        path = "/api/v2/companies/#{companyId}/filings/#{worksheetId}/checkup"
+        
+        get(path)
+      end
+
+
+      # Retrieve worksheet checkup report for company and filing period.
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The unique ID of the company that owns the worksheets object.
+      # @param int year The year of the filing period.
+      # @param int month The month of the filing period.
+      # @return FilingsCheckupModel
+      def filings_checkup_reports(companyId, year, month)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/checkup"
+        
+        get(path)
+      end
+
+
+      # Retrieve a single attachment for a filing
+      # 
+      # This API is available by invitation only.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int filingId The unique id of the worksheet return.
+      # @param int fileId The unique id of the document you are downloading
+      # @return FileResult
+      def get_filing_attachment(companyId, filingId, options={})
+        path = "/api/v2/companies/#{companyId}/filings/#{filingId}/attachment"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve a list of filings for the specified company in the year and month of a given filing period.
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @return FileResult
+      def get_filing_attachments(companyId, year, month)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/attachments"
+        
+        get(path)
+      end
+
+
+      # Retrieve a single trace file for a company filing period
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @return FileResult
+      def get_filing_attachments_trace_file(companyId, year, month)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/attachments/tracefile"
+        
+        get(path)
+      end
+
+
+      # Retrieve a list of filings for the specified company in the year and month of a given filing period.
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @return FetchResult
+      def get_filings(companyId, year, month)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}"
+        
+        get(path)
+      end
+
+
+      # Retrieve a list of filings for the specified company in the given filing period and country.
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @return FetchResult
+      def get_filings_by_country(companyId, year, month, country)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}"
+        
+        get(path)
+      end
+
+
+      # Retrieve a list of filings for the specified company in the filing period, country and region.
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param string region The two or three character region code for the region.
+      # @return FetchResult
+      def get_filings_by_country_region(companyId, year, month, country, region)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}"
+        
+        get(path)
+      end
+
+
+      # Retrieve a list of filings for the specified company in the given filing period, country, region and form.
+      # 
+      # This API is available by invitation only.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period.
+      # @param int month The two digit month of the filing period.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param string region The two or three character region code for the region.
+      # @param string formCode The unique code of the form.
+      # @return FetchResult
+      def get_filings_by_return_name(companyId, year, month, country, region, formCode)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}"
+        
+        get(path)
+      end
+
+
+      # Rebuild a set of filings for the specified company in the given filing period.
+      # 
+      # This API is available by invitation only.
+      # Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.
+      # Rebuilding has to be done whenever a customer adds transactions to a filing.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # This API requires filing to be unapproved.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to be rebuilt.
+      # @param int month The month of the filing period to be rebuilt.
+      # @param RebuildFilingsModel model The rebuild request you wish to execute.
+      # @return FetchResult
+      def rebuild_filings(companyId, year, month, model)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/rebuild"
+        
+        post(path, model)
+      end
+
+
+      # Rebuild a set of filings for the specified company in the given filing period and country.
+      # 
+      # This API is available by invitation only.
+      # Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.
+      # Rebuilding has to be done whenever a customer adds transactions to a filing.
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # This API requires filing to be unapproved.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to be rebuilt.
+      # @param int month The month of the filing period to be rebuilt.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param RebuildFilingsModel model The rebuild request you wish to execute.
+      # @return FetchResult
+      def rebuild_filings_by_country(companyId, year, month, country, model)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/rebuild"
+        
+        post(path, model)
+      end
+
+
+      # Rebuild a set of filings for the specified company in the given filing period, country and region.
+      # 
+      # This API is available by invitation only.
+      # Rebuilding a return means re-creating or updating the amounts to be filed for a filing.
+      # Rebuilding has to be done whenever a customer adds transactions to a filing. 
+      # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, 
+      # based on filing frequency of filing.
+      # This API requires filing to be unapproved.
+      # 
+      # @param int companyId The ID of the company that owns the filings.
+      # @param int year The year of the filing period to be rebuilt.
+      # @param int month The month of the filing period to be rebuilt.
+      # @param string country The two-character ISO-3166 code for the country.
+      # @param string region The two or three character region code for the region.
+      # @param RebuildFilingsModel model The rebuild request you wish to execute.
+      # @return FetchResult
+      def rebuild_filings_by_country_region(companyId, year, month, country, region, model)
+        path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/rebuild"
+        
+        post(path, model)
+      end
+
+
+      # Edit an adjustment for a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
+      # such as early filer discount amounts that are refunded to the customer, or efile fees from websites. 
+      # Sometimes may be a manual change in tax liability similar to an augmentation.
+      # This API modifies an adjustment for an existing tax filing.
+      # This API can only be used when the filing has not yet been approved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being adjusted.
+      # @param int id The ID of the adjustment being edited.
+      # @param FilingAdjustmentModel model The updated Adjustment.
+      # @return FilingAdjustmentModel
+      def update_return_adjustment(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filings/adjust/#{id}"
+        
+        put(path, model)
+      end
+
+
+      # Edit an augmentation for a given filing.
+      # 
+      # This API is available by invitation only.
+      # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara 
+      # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
+      # This API modifies an augmentation for an existing tax filing.
+      # This API can only be used when the filing has not been approved.
+      # 
+      # @param int companyId The ID of the company that owns the filing being changed.
+      # @param int id The ID of the augmentation being edited.
+      # @param FilingAugmentationModel model The updated Augmentation.
+      # @return FilingModel
+      def update_return_augmentation(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/filings/augment/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end