filings

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 11, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for filings API

func (*Client) GetAccrualFilings 

func (a *Client) GetAccrualFilings(params *GetAccrualFilingsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetAccrualFilingsOK, error)
GetAccrualFilings retrieves a filing containing the return and all its accrual returns

### Security Policies

* This API requires openId bearer token for authentication * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.

func (*Client) GetFiledReturns 

func (a *Client) GetFiledReturns(params *GetFiledReturnsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetFiledReturnsOK, error)
GetFiledReturns retrieves a list of filed returns for the specified company in the year and month of a given filing period

### Security Policies

* This API requires openId bearer token for authentication * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	GetAccrualFilings(params *GetAccrualFilingsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetAccrualFilingsOK, error)

	GetFiledReturns(params *GetFiledReturnsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetFiledReturnsOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new filings API client.

type GetAccrualFilingsBadRequest 

type GetAccrualFilingsBadRequest struct {
}
GetAccrualFilingsBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewGetAccrualFilingsBadRequest 

func NewGetAccrualFilingsBadRequest() *GetAccrualFilingsBadRequest

NewGetAccrualFilingsBadRequest creates a GetAccrualFilingsBadRequest with default headers values

func (*GetAccrualFilingsBadRequest) Error 

func (o *GetAccrualFilingsBadRequest) Error() string

type GetAccrualFilingsNotFound 

type GetAccrualFilingsNotFound struct {
}
GetAccrualFilingsNotFound describes a response with status code 404, with default header values.

Not Found

func NewGetAccrualFilingsNotFound 

func NewGetAccrualFilingsNotFound() *GetAccrualFilingsNotFound

NewGetAccrualFilingsNotFound creates a GetAccrualFilingsNotFound with default headers values

func (*GetAccrualFilingsNotFound) Error 

func (o *GetAccrualFilingsNotFound) Error() string

type GetAccrualFilingsOK 

type GetAccrualFilingsOK struct {
	Payload *models.MultiTaxFilingModelFetchResult
}
GetAccrualFilingsOK describes a response with status code 200, with default header values.

Success

func NewGetAccrualFilingsOK 

func NewGetAccrualFilingsOK() *GetAccrualFilingsOK

NewGetAccrualFilingsOK creates a GetAccrualFilingsOK with default headers values

func (*GetAccrualFilingsOK) Error 

func (o *GetAccrualFilingsOK) Error() string

func (*GetAccrualFilingsOK) GetPayload 

func (o *GetAccrualFilingsOK) GetPayload() *models.MultiTaxFilingModelFetchResult

type GetAccrualFilingsParams 

type GetAccrualFilingsParams struct {

	/* XAvalaraClient.

	   Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .

	   Default: "Swagger UI; 21.12.0; Custom; 1.0"
	*/
	XAvalaraClient *string

	/* CompanyID.

	   The ID of the company that owns these returns

	   Format: int32
	*/
	CompanyID int32

	/* FilingReturnID.

	   The ID of the filing return

	   Format: int64
	*/
	FilingReturnID int64

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetAccrualFilingsParams contains all the parameters to send to the API endpoint 

for the get accrual filings operation.

Typically these are written to a http.Request.

func NewGetAccrualFilingsParams 

func NewGetAccrualFilingsParams() *GetAccrualFilingsParams

NewGetAccrualFilingsParams creates a new GetAccrualFilingsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetAccrualFilingsParamsWithContext 

func NewGetAccrualFilingsParamsWithContext(ctx context.Context) *GetAccrualFilingsParams

NewGetAccrualFilingsParamsWithContext creates a new GetAccrualFilingsParams object with the ability to set a context for a request.

func NewGetAccrualFilingsParamsWithHTTPClient 

func NewGetAccrualFilingsParamsWithHTTPClient(client *http.Client) *GetAccrualFilingsParams

NewGetAccrualFilingsParamsWithHTTPClient creates a new GetAccrualFilingsParams object with the ability to set a custom HTTPClient for a request.

func NewGetAccrualFilingsParamsWithTimeout 

func NewGetAccrualFilingsParamsWithTimeout(timeout time.Duration) *GetAccrualFilingsParams

NewGetAccrualFilingsParamsWithTimeout creates a new GetAccrualFilingsParams object with the ability to set a timeout on a request.

func (*GetAccrualFilingsParams) SetCompanyID 

func (o *GetAccrualFilingsParams) SetCompanyID(companyID int32)

SetCompanyID adds the companyId to the get accrual filings params

func (*GetAccrualFilingsParams) SetContext 

func (o *GetAccrualFilingsParams) SetContext(ctx context.Context)

SetContext adds the context to the get accrual filings params

func (*GetAccrualFilingsParams) SetDefaults 

func (o *GetAccrualFilingsParams) SetDefaults()

SetDefaults hydrates default values in the get accrual filings params (not the query body).

All values with no default are reset to their zero value.

func (*GetAccrualFilingsParams) SetFilingReturnID 

func (o *GetAccrualFilingsParams) SetFilingReturnID(filingReturnID int64)

SetFilingReturnID adds the filingReturnId to the get accrual filings params

func (*GetAccrualFilingsParams) SetHTTPClient 

func (o *GetAccrualFilingsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get accrual filings params

func (*GetAccrualFilingsParams) SetTimeout 

func (o *GetAccrualFilingsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get accrual filings params

func (*GetAccrualFilingsParams) SetXAvalaraClient 

func (o *GetAccrualFilingsParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the get accrual filings params

func (*GetAccrualFilingsParams) WithCompanyID 

func (o *GetAccrualFilingsParams) WithCompanyID(companyID int32) *GetAccrualFilingsParams

WithCompanyID adds the companyID to the get accrual filings params

func (*GetAccrualFilingsParams) WithContext 

func (o *GetAccrualFilingsParams) WithContext(ctx context.Context) *GetAccrualFilingsParams

WithContext adds the context to the get accrual filings params

func (*GetAccrualFilingsParams) WithDefaults 

func (o *GetAccrualFilingsParams) WithDefaults() *GetAccrualFilingsParams

WithDefaults hydrates default values in the get accrual filings params (not the query body).

All values with no default are reset to their zero value.

func (*GetAccrualFilingsParams) WithFilingReturnID 

func (o *GetAccrualFilingsParams) WithFilingReturnID(filingReturnID int64) *GetAccrualFilingsParams

WithFilingReturnID adds the filingReturnID to the get accrual filings params

func (*GetAccrualFilingsParams) WithHTTPClient 

func (o *GetAccrualFilingsParams) WithHTTPClient(client *http.Client) *GetAccrualFilingsParams

WithHTTPClient adds the HTTPClient to the get accrual filings params

func (*GetAccrualFilingsParams) WithTimeout 

func (o *GetAccrualFilingsParams) WithTimeout(timeout time.Duration) *GetAccrualFilingsParams

WithTimeout adds the timeout to the get accrual filings params

func (*GetAccrualFilingsParams) WithXAvalaraClient 

func (o *GetAccrualFilingsParams) WithXAvalaraClient(xAvalaraClient *string) *GetAccrualFilingsParams

WithXAvalaraClient adds the xAvalaraClient to the get accrual filings params

func (*GetAccrualFilingsParams) WriteToRequest 

func (o *GetAccrualFilingsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetAccrualFilingsReader 

type GetAccrualFilingsReader struct {
	// contains filtered or unexported fields
}

GetAccrualFilingsReader is a Reader for the GetAccrualFilings structure.

func (*GetAccrualFilingsReader) ReadResponse 

func (o *GetAccrualFilingsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetAccrualFilingsUnauthorized 

type GetAccrualFilingsUnauthorized struct {
}
GetAccrualFilingsUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewGetAccrualFilingsUnauthorized 

func NewGetAccrualFilingsUnauthorized() *GetAccrualFilingsUnauthorized

NewGetAccrualFilingsUnauthorized creates a GetAccrualFilingsUnauthorized with default headers values

func (*GetAccrualFilingsUnauthorized) Error 

func (o *GetAccrualFilingsUnauthorized) Error() string

type GetFiledReturnsBadRequest 

type GetFiledReturnsBadRequest struct {
}
GetFiledReturnsBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewGetFiledReturnsBadRequest 

func NewGetFiledReturnsBadRequest() *GetFiledReturnsBadRequest

NewGetFiledReturnsBadRequest creates a GetFiledReturnsBadRequest with default headers values

func (*GetFiledReturnsBadRequest) Error 

func (o *GetFiledReturnsBadRequest) Error() string

type GetFiledReturnsNotFound 

type GetFiledReturnsNotFound struct {
}
GetFiledReturnsNotFound describes a response with status code 404, with default header values.

Not Found

func NewGetFiledReturnsNotFound 

func NewGetFiledReturnsNotFound() *GetFiledReturnsNotFound

NewGetFiledReturnsNotFound creates a GetFiledReturnsNotFound with default headers values

func (*GetFiledReturnsNotFound) Error 

func (o *GetFiledReturnsNotFound) Error() string

type GetFiledReturnsOK 

type GetFiledReturnsOK struct {
	Payload *models.FiledReturnModelFetchResult
}
GetFiledReturnsOK describes a response with status code 200, with default header values.

Success

func NewGetFiledReturnsOK 

func NewGetFiledReturnsOK() *GetFiledReturnsOK

NewGetFiledReturnsOK creates a GetFiledReturnsOK with default headers values

func (*GetFiledReturnsOK) Error 

func (o *GetFiledReturnsOK) Error() string

func (*GetFiledReturnsOK) GetPayload 

func (o *GetFiledReturnsOK) GetPayload() *models.FiledReturnModelFetchResult

type GetFiledReturnsParams 

type GetFiledReturnsParams struct {

	/* XAvalaraClient.

	   Identifies the software you are using to call this API.  For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .

	   Default: "Swagger UI; 21.12.0; Custom; 1.0"
	*/
	XAvalaraClient *string

	/* CompanyID.

	   The ID of the company that owns these batches

	   Format: int32
	*/
	CompanyID int32

	/* Country.

	   The country of the return(s) you are trying to retrieve
	*/
	Country *string

	/* EndPeriodMonth.

	   The month of the period you are trying to retrieve

	   Format: int32
	*/
	EndPeriodMonth *int32

	/* EndPeriodYear.

	   The year of the period you are trying to retrieve

	   Format: int32
	*/
	EndPeriodYear *int32

	/* FilingCalendarID.

	   The filing calendar id of the return you are trying to retrieve

	   Format: int64
	*/
	FilingCalendarID *int64

	/* Frequency.

	   The frequency of the return you are trying to retrieve
	*/
	Frequency *string

	/* Region.

	   The region of the return(s) you are trying to retrieve
	*/
	Region *string

	/* Status.

	   The status of the return(s) you are trying to retrieve
	*/
	Status *string

	/* TaxformCode.

	   The unique tax form code of the form.
	*/
	TaxformCode *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetFiledReturnsParams contains all the parameters to send to the API endpoint 

for the get filed returns operation.

Typically these are written to a http.Request.

func NewGetFiledReturnsParams 

func NewGetFiledReturnsParams() *GetFiledReturnsParams

NewGetFiledReturnsParams creates a new GetFiledReturnsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetFiledReturnsParamsWithContext 

func NewGetFiledReturnsParamsWithContext(ctx context.Context) *GetFiledReturnsParams

NewGetFiledReturnsParamsWithContext creates a new GetFiledReturnsParams object with the ability to set a context for a request.

func NewGetFiledReturnsParamsWithHTTPClient 

func NewGetFiledReturnsParamsWithHTTPClient(client *http.Client) *GetFiledReturnsParams

NewGetFiledReturnsParamsWithHTTPClient creates a new GetFiledReturnsParams object with the ability to set a custom HTTPClient for a request.

func NewGetFiledReturnsParamsWithTimeout 

func NewGetFiledReturnsParamsWithTimeout(timeout time.Duration) *GetFiledReturnsParams

NewGetFiledReturnsParamsWithTimeout creates a new GetFiledReturnsParams object with the ability to set a timeout on a request.

func (*GetFiledReturnsParams) SetCompanyID 

func (o *GetFiledReturnsParams) SetCompanyID(companyID int32)

SetCompanyID adds the companyId to the get filed returns params

func (*GetFiledReturnsParams) SetContext 

func (o *GetFiledReturnsParams) SetContext(ctx context.Context)

SetContext adds the context to the get filed returns params

func (*GetFiledReturnsParams) SetCountry 

func (o *GetFiledReturnsParams) SetCountry(country *string)

SetCountry adds the country to the get filed returns params

func (*GetFiledReturnsParams) SetDefaults 

func (o *GetFiledReturnsParams) SetDefaults()

SetDefaults hydrates default values in the get filed returns params (not the query body).

All values with no default are reset to their zero value.

func (*GetFiledReturnsParams) SetEndPeriodMonth 

func (o *GetFiledReturnsParams) SetEndPeriodMonth(endPeriodMonth *int32)

SetEndPeriodMonth adds the endPeriodMonth to the get filed returns params

func (*GetFiledReturnsParams) SetEndPeriodYear 

func (o *GetFiledReturnsParams) SetEndPeriodYear(endPeriodYear *int32)

SetEndPeriodYear adds the endPeriodYear to the get filed returns params

func (*GetFiledReturnsParams) SetFilingCalendarID 

func (o *GetFiledReturnsParams) SetFilingCalendarID(filingCalendarID *int64)

SetFilingCalendarID adds the filingCalendarId to the get filed returns params

func (*GetFiledReturnsParams) SetFrequency 

func (o *GetFiledReturnsParams) SetFrequency(frequency *string)

SetFrequency adds the frequency to the get filed returns params

func (*GetFiledReturnsParams) SetHTTPClient 

func (o *GetFiledReturnsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get filed returns params

func (*GetFiledReturnsParams) SetRegion 

func (o *GetFiledReturnsParams) SetRegion(region *string)

SetRegion adds the region to the get filed returns params

func (*GetFiledReturnsParams) SetStatus 

func (o *GetFiledReturnsParams) SetStatus(status *string)

SetStatus adds the status to the get filed returns params

func (*GetFiledReturnsParams) SetTaxformCode 

func (o *GetFiledReturnsParams) SetTaxformCode(taxformCode *string)

SetTaxformCode adds the taxformCode to the get filed returns params

func (*GetFiledReturnsParams) SetTimeout 

func (o *GetFiledReturnsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get filed returns params

func (*GetFiledReturnsParams) SetXAvalaraClient 

func (o *GetFiledReturnsParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the get filed returns params

func (*GetFiledReturnsParams) WithCompanyID 

func (o *GetFiledReturnsParams) WithCompanyID(companyID int32) *GetFiledReturnsParams

WithCompanyID adds the companyID to the get filed returns params

func (*GetFiledReturnsParams) WithContext 

func (o *GetFiledReturnsParams) WithContext(ctx context.Context) *GetFiledReturnsParams

WithContext adds the context to the get filed returns params

func (*GetFiledReturnsParams) WithCountry 

func (o *GetFiledReturnsParams) WithCountry(country *string) *GetFiledReturnsParams

WithCountry adds the country to the get filed returns params

func (*GetFiledReturnsParams) WithDefaults 

func (o *GetFiledReturnsParams) WithDefaults() *GetFiledReturnsParams

WithDefaults hydrates default values in the get filed returns params (not the query body).

All values with no default are reset to their zero value.

func (*GetFiledReturnsParams) WithEndPeriodMonth 

func (o *GetFiledReturnsParams) WithEndPeriodMonth(endPeriodMonth *int32) *GetFiledReturnsParams

WithEndPeriodMonth adds the endPeriodMonth to the get filed returns params

func (*GetFiledReturnsParams) WithEndPeriodYear 

func (o *GetFiledReturnsParams) WithEndPeriodYear(endPeriodYear *int32) *GetFiledReturnsParams

WithEndPeriodYear adds the endPeriodYear to the get filed returns params

func (*GetFiledReturnsParams) WithFilingCalendarID 

func (o *GetFiledReturnsParams) WithFilingCalendarID(filingCalendarID *int64) *GetFiledReturnsParams

WithFilingCalendarID adds the filingCalendarID to the get filed returns params

func (*GetFiledReturnsParams) WithFrequency 

func (o *GetFiledReturnsParams) WithFrequency(frequency *string) *GetFiledReturnsParams

WithFrequency adds the frequency to the get filed returns params

func (*GetFiledReturnsParams) WithHTTPClient 

func (o *GetFiledReturnsParams) WithHTTPClient(client *http.Client) *GetFiledReturnsParams

WithHTTPClient adds the HTTPClient to the get filed returns params

func (*GetFiledReturnsParams) WithRegion 

func (o *GetFiledReturnsParams) WithRegion(region *string) *GetFiledReturnsParams

WithRegion adds the region to the get filed returns params

func (*GetFiledReturnsParams) WithStatus 

func (o *GetFiledReturnsParams) WithStatus(status *string) *GetFiledReturnsParams

WithStatus adds the status to the get filed returns params

func (*GetFiledReturnsParams) WithTaxformCode 

func (o *GetFiledReturnsParams) WithTaxformCode(taxformCode *string) *GetFiledReturnsParams

WithTaxformCode adds the taxformCode to the get filed returns params

func (*GetFiledReturnsParams) WithTimeout 

func (o *GetFiledReturnsParams) WithTimeout(timeout time.Duration) *GetFiledReturnsParams

WithTimeout adds the timeout to the get filed returns params

func (*GetFiledReturnsParams) WithXAvalaraClient 

func (o *GetFiledReturnsParams) WithXAvalaraClient(xAvalaraClient *string) *GetFiledReturnsParams

WithXAvalaraClient adds the xAvalaraClient to the get filed returns params

func (*GetFiledReturnsParams) WriteToRequest 

func (o *GetFiledReturnsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetFiledReturnsReader 

type GetFiledReturnsReader struct {
	// contains filtered or unexported fields
}

GetFiledReturnsReader is a Reader for the GetFiledReturns structure.

func (*GetFiledReturnsReader) ReadResponse 

func (o *GetFiledReturnsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetFiledReturnsUnauthorized 

type GetFiledReturnsUnauthorized struct {
}
GetFiledReturnsUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewGetFiledReturnsUnauthorized 

func NewGetFiledReturnsUnauthorized() *GetFiledReturnsUnauthorized

NewGetFiledReturnsUnauthorized creates a GetFiledReturnsUnauthorized with default headers values

func (*GetFiledReturnsUnauthorized) Error 

func (o *GetFiledReturnsUnauthorized) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.