> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/circulation-user-manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/circulation-user-manual/customer-service/transactions/stop.md).

# Stop

Subscribers sometimes wish to stop a subscription. A stop can be either temporary or permanent; the reason code determines the type of stop it is. Business Rules determine whether a source code is required for a stop.

Multiple stop and restart dates can be entered for the same subscriber, and you can modify future stop/restart dates. You can enter a permanent stop for a temporarily stopped subscription, but you may not enter a second temporary stop if a restart has not been entered for the first temporary stop.

A Temporary Stop transaction can be entered even if its date range overlaps with an existing Move transaction (MoveIn or MoveOut) for the same subscription.

When entering a temp stop (or a perm stop on a temp-stopped account) the subscriber may be forced to donate some or all of the stopped days, based on the vacation credit Business Rules in the General section (see General in the Setup manual) and the reason code used. When there is a forced donation, the message “The first XX calendar days for this temporary stop will not be credited to subscription XX” displays. The actual donation transaction record is created during Transaction Processing, so you will not see the number of days donated in the transaction until it has been processed.

If a stop is entered for a date that has already been processed, a warning message is displayed. A subscription may not be stopped on a date which exceeds the allowed number of back-dating days.

If a subscriber has a combo subscription, all publications in the combo can be stopped at the same time by selecting the combo ID in the Product field. In addition, a temp stop may be entered for an individual publication in the combo if Must Stop Together is unchecked in Combo Setup. For example, if a subscriber has an online and print combo and wishes to temp stop the print publication, the combo must be set up with Must Stop Together unchecked. See Combo in the Setup Manual for more information. Combo subscriptions can also be ended via an [end combo transaction](/circulation-user-manual/customer-service/transactions/end-combo.md).

Processing a Permanent Stop,

1. When there are multiple unprocessed payments for the same subscriber with different dates in the system, the General Ledger (GL) batch date is set to the latest transaction date of the payments.
2. When there is a single unprocessed payment in the system, the GL batch date is set to the payment’s transaction date.
3. If a subscription has an unprocessed start that cannot be routed, the processing of a permanent stop is controlled by a Business Rule in the Customer Services section.
   * If the Business Rule **Are Perm Stops allowed to be processed for unprocessed and unrouteable Starts?** (*Customer Services section*) is set to **Yes**, the permanent stop will process. If a payment exists on the unprocessed start transaction, an **Available Refund (AvailRefund)** transaction is created.

     If the Business Rule is set to **No**, the permanent stop will not be processed.

## About Vacation Packs

When entering a temp stop, the subscriber can elect to receive a ***vacation pack***, if your publication has a vacation pack program. A vacation pack is an arrangement in which the newspaper (carrier or DM) holds papers for subscribers while they are gone and then delivers them when the subscribers return (restart). Vacation pack days can extend the subscriber’s expire date by full or half day increments, based on rate terms. You can also print [vacation pack labels](/circulation-user-manual/reporting/account-menu/vacation-pack-labels.md) for carriers.

You can also offer a ***digital vacation pack***. In this case no papers are held, but the subscriber is given access to the online version of the publication. The stop reason code determines whether the subscriber qualifies for a digital vacation pack (Online Vacation field set to “y” in Reason Code setup). An Online Vacation reason code can only be selected if the subscription is entirely route-delivered (not mail or hybrid), the delivery schedule has Digital Vac Hold set to “y” in Delivery Schedule setup, and the subscriber has a valid e-mail address (the e-mail is used to log into the digital edition). When a digital vacation pack stop is entered, an e-mail is sent to the subscriber with links to the publication web site. This e-mail is based on an HTML template that can be customized (see [Digital Vacation Pack template](/circulation-user-manual/14-appendix-b-file-formats/e-mail-templates/digital-vacation-pack-template.md)). While a subscriber is on the digital vacation pack, their status will be “Vac-Online.” Carriers will receive stop messages on bundle tops, as with a normal temp stop. Subscriber rating will value the digital “copies” at the same rate as ordinary (route-delivered) copies; the vacation pack fields in the subscriber rate terms are not considered.

Business Rules determine whether the subscriber’s expire date can be extended during a vacation pack and whether reminder messages print on bundle tops. Business Rules also determine whether digital vacation packs are offered, the AAM column digital vacation copies should be reported under, the label group for digital vac packs (used to determine the edition) and the electronic edition subscribers will be given access to. E-mail configuration and settings related to the digital vacation pack template are defined in Website Setup (see [Website ](https://docs.navigaglobal.com/circulation-setup-manual/system/website)in the Setup Manual).

## **Real-Time Data Synchronization**

When a stop transaction is entered, Circulation generates a real-time data extract file if the Business Rule ***Should real-time data feed be allowed to external systems?*** (General section) is set to **Yes**. This Business Rule can be configured at the Business and Publication levels and supports multi-selection by ProductID. If the Business Rule is set to **No**, no real-time extract file is generated for stop transactions.

The extract file is created based on the transaction's Create Date/Time and is transferred to an AWS S3 bucket via a cron job for client access. Each file is generated per record with unique nomenclature. The database name is prefixed in the filename, and the database ID is included as the first field.

The extract file is written to the following location:

* `[defaultdir]/cm/realtimedata` (for CM)
* `[defaultdir]/hm/realtimedata` (for CircAPI)

The extract file includes the following fields:

* **DatabaseID** — The database identifier.
* **SubscriptionID** — The subscription identifier.
* **ProductID** — The product identifier.
* **CompanyID** — The company identifier.
* **DeliveryMethod** — The delivery method for the subscription.
* **DeliverySchedule** — The delivery schedule for the subscription.
* **RateCodeID** — The rate code identifier.
* **AutorenewType** — The type of auto-renewal for the subscription.
* **AutoRenewTerm** — The subscription's auto-renewal term.
* **AutoRenewLength** — The duration of the auto-renewal period.
* **CCType/PaymentSource** — The credit card type or payment source.
* **TranTypeID** — The transaction type identifier.
* **TranNumber** — The transaction number associated with the subscription transaction.
* **Route/LabelGroup** — The route or mail label group assigned to the subscription.
* **Reason** — The reason code for the transaction.
* **Source** — The source of the transaction.
* **SubSource** — The sub-source of the transaction.
* **BillOccEmailAddress** — The billing occupant's email address.
* **TranDate** — The date of the transaction.
* **LastStartDate** — The date of the subscriber's most recent start.
* **RefundRequested** — Indicates whether a refund was requested for the transaction.
* **CreateUser** — The user who created the transaction.
* **CreateDate** — The date the transaction was created.
* **CreateTime** — The time the transaction was created.

> **Note:** *For setup and configuration of real-time data synchronization, contact Naviga Global Support.*

## Entering a Stop

#### To stop a subscription:

1. Find the subscriber whose subscription should be stopped.
2. Click the Stop button (<img src="https://1417315899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1ToZXx8io0JJXNBRcPOt%2Fuploads%2FCkftsiwX9snGP6q84WWw%2FStop.png?alt=media&amp;token=3bae17a0-3b45-41de-94bc-bfb6d360d672" alt="" data-size="line">). The stop transaction fields display in the Transactions tab.

   <figure><img src="https://1417315899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1ToZXx8io0JJXNBRcPOt%2Fuploads%2FwN2ssYcWONA936sF6M4l%2Fimage.png?alt=media&amp;token=7ad32703-bbe9-47d0-ab14-2fe3bb976acd" alt=""><figcaption></figcaption></figure>
3. Complete the following fields and click OK.<br>

   <table><thead><tr><th width="180.33333333333331">Field</th><th width="131">Type</th><th>What to enter</th></tr></thead><tbody><tr><td><strong>Stop Information</strong></td><td> </td><td> </td></tr><tr><td>PRODUCT</td><td>setup</td><td>Select the publication to be stopped or leave the default.</td></tr><tr><td>STOP DATE</td><td>date</td><td>Enter the first date that the subscriber will not receive the subscription.</td></tr><tr><td>SOURCE</td><td>setup</td><td>Enter the source code for this transaction, such as “customer” or “carrier”.</td></tr><tr><td>SUBSOURCE</td><td>setup</td><td>If this field is active, enter a sub source for the stop (for example, the carrier who called in the stop).</td></tr><tr><td>STOP REASON</td><td>setup</td><td><p>Enter the reason code for this stop, such as “vacation”. If a reminder message is set up for the reason code, it will be displayed in a popup window after this field is entered.<br><br>Colored spheres next to each valid reason code indicate if the reason is for a temporary stop (yellow sphere) or permanent stop (red sphere).</p><p></p><p>The Reason Codes displayed are determined by the subscriber type as follows:</p><ul><li><strong>Route subscribers</strong> — Reason Codes with "Online Vacation" set to "Yes" or "No" are displayed.</li><li><strong>Mail subscribers</strong> — Reason Codes with "Online Vacation" set to "Yes" or "No" are displayed.</li><li><strong>Online subscribers</strong> — only Reason Codes with "Online Vacation" set to "No" are displayed.</li></ul></td></tr><tr><td>RESTART DATE</td><td>date</td><td>If the stop is temporary and the restart date is known, enter the first date that this subscription should be restarted.</td></tr><tr><td>RESTART REASON</td><td>setup</td><td>If you entered a Restart Date, enter a reason for the restart.</td></tr><tr><td>VACATION PACK?</td><td>yes/no</td><td><p>If this is a temporary stop, indicate if the customer requested a “vacation pack”. This check box defaults based on the reason code.</p><p> </p><p>You can set up your rates to give subscribers some or all of their vacation pack papers for free, based on the rate term. If the subscriber has one of these promotional rates, the number of free full and half vac pack days they have available will be displayed in the Vacation Pack Detail panel. Subscribers receiving a vacation pack promotion will have their expire dates extended by the appropriate number of days.</p><p> </p><p>When entering a temp stop with a reason code that allows digital vacation packs, this and Hold All Days will be flagged and inaccessible.</p></td></tr><tr><td>PREVIOUS DELIVERY?</td><td>yes/no</td><td>If you entered a date in Restart Date, indicate whether a previous day’s paper should be delivered with the restart. This field will be unchecked unless previous papers are offered to restarting subscribers.</td></tr><tr><td>SEND EMAIL CONFIRMATION</td><td>yes/no</td><td>An e-mail confirmation message for the stop can be sent to the subscriber, if you have e-mail confirmations implemented for stops and the subscriber qualifies (see <a href="/circulation-user-manual/customer-service/transactions.md#about-e-mail-confirmations">About E-mail Confirmations</a>).</td></tr><tr><td>REQUESTED REFUND?</td><td>yes/no</td><td><p>If this is a permanent stop, indicate whether the customer requested a refund of the account balance. This field will not be active if the subscriber has no balance.</p><p></p><p>Transaction Security can be applied to this field to control access at the user level. By default, the field is blank. If a Security ID is assigned, only users associated with that Security ID can access the <strong>Requested Refund?</strong> checkbox. Users who are not associated with the Security ID will not have access to this field.</p><p>Transaction Security for this field is configured under: <strong>Setup > System > Security > Transaction Security > CSMReqRefund.</strong></p><p></p><p>Checking <strong>Requested Refund?</strong> does not automatically create a refund transaction. Refunds must be entered separately, either individually or in batches. However, the Available Refunds Report can be run for refund requests, and this report can then be used to enter refunds for subscribers who requested one.</p></td></tr><tr><td>REMARKS</td><td>unlimited</td><td>Enter any remarks that should appear on the carrier’s bundle top and/or the District Manager Report.</td></tr><tr><td> </td><td> </td><td> </td></tr><tr><td><strong>Vacation Pack Detail</strong></td><td> </td><td> </td></tr><tr><td>HOLD ALL DAYS?</td><td>yes/no</td><td>If Vacation Pack is checked, indicate if the subscriber wants all days held for the vacation pack period.<br><br>Note that, if a restart date is entered which is beyond the subscription’s expiration date (and the subscriber will go into grace), all days of the vacation pack must be held, and this check box must be selected.</td></tr><tr><td>SELECTED WEEKDAYS?</td><td>yes/no</td><td>Select this check box if the subscriber wants only specific days of the week held (e.g., Wednesdays and Sundays) while on vacation. Use the Monday-Sunday check boxes to indicate which days should be held. The availability of this option depends on Business Rules.</td></tr><tr><td>SPECIFIC DATES?</td><td>yes/no</td><td>Select this check box if there are specific dates that the vac pack subscriber wants held (e.g., 3/14, 3/17). Then, select the dates from the calendar. The availability of this option depends on Business Rules.</td></tr><tr><td>DONATE REMAINDER?</td><td>yes/no</td><td>Select this check box if the vac pack subscriber wants to donate the papers that are not being held. Note that donations are not allowed for subscribers on marketing term rates that are in grace and are only allowed for in grace combo subscribers when donations are forced by vacation credit rules.</td></tr><tr><td> </td><td> </td><td> </td></tr><tr><td><strong>Donation Detail</strong></td><td> </td><td> </td></tr><tr><td>CODE</td><td>setup<br>integer (5)</td><td><p>If the subscriber wishes to donate some or all the value of their papers for the stopped period (whether a temporary or permanent stop), enter the donation code, which determines the party that will receive the donation (the current carrier, a specific carrier, prompt for carrier, or a GL account). Donation codes must be set up in advance.</p><p></p><p>A <strong>Donation Code</strong> cannot be added when creating a permanent stop for a subscription that uses a non-refundable <strong>Rate Code</strong>.</p><p>If the subscription’s <strong>Rate Code</strong> is non-refundable, the donation fields are not available for the permanent stop transaction.<br><br>If the donation should go to the current carrier, and this is a multi-carrier subscription, the donation will be divided evenly among the carriers.<br><br>If the subscriber is not office pay, or this is a temp stop without a restart date, the donation fields will not open.</p></td></tr><tr><td>ALL DAYS?,<br>DAYS</td><td>yes/no<br>integer (5)</td><td>If a donation code is entered, indicate whether all days should be donated. For permanent stops, this means all the days remaining in the subscription period. For temporary stops, this means all days during which the subscription is stopped. If you do not check All Days, you can specify a number of days to donate.</td></tr><tr><td> </td><td> </td><td> </td></tr><tr><td><strong>Refund Detail</strong></td><td> </td><td> </td></tr><tr><td>AMOUNT</td><td>display</td><td>If you checked <em>Requested Refund?</em> the available refund amount is displayed. You can click the Address Override button and enter the address to which the refund should be sent (otherwise, the refund will be sent to the customer’s normal address). Note that if the subscriber is already set up in your AP system, their address will not be updated.</td></tr></tbody></table>
