Exemption Certificate Management

CertCapture RESTful APIs

CycleAddOptionModel

Model with options for adding a new filing calendar

Parameters
availableOptional
boolean

True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date.

transactionalPeriodStartOptional
string

The period start date for the customer's first transaction in the jurisdiction being added

transactionalPeriodEndOptional
string

The period end date for the customer's last transaction in the jurisdiction being added

filingDueDateOptional
string

The jurisdiction-assigned due date for the form

cycleNameOptional
string

A descriptive name of the cycle and due date of form.

frequencyNameOptional
string

The filing frequency of the form

filingFrequencyCodeOptional
string

A code assigned to the filing frequency

filingFrequencyIdOptional
string

The filing frequency of the request

Enum: Monthly, Quarterly, SemiAnnually, Annually, Bimonthly, Occasional, InverseQuarterly, Weekly
cycleUnavailableReasonOptional
string

An explanation for why this form cannot be added for the current cycle

availableLocationCodesOptional
array

A list of outlet codes that can be assigned to this form for the current cycle