Terminate Order

post

https://api.recvue.com/api/v2.0/orders/{orderId}/terminate

Terminates an active order in RecVue. Supports full order cancellation, partial line termination, and amendment-based workflows (save as draft or submit for approval).

Processing Modes (controlled by action field):

Immediate (default, omit action): Processes termination instantly
SAVE: Creates a draft amendment for review before committing
SUBMIT: Submits the termination through the approval workflow

Credit Options:

calculateCredit: Y — Auto-calculate credit based on unused period
creditMethod: PRORATE — Prorate credit for the remaining billing period
creditMethod: FULL — Issue full credit regardless of timing
creditMethod: NONE — Terminate without issuing credit
fullCredit: Y — Shortcut to issue full credit
noCredit: Y — Shortcut to terminate without any credit

Termination Scope:

Full order: Set fullCancellation: true
Single line by number: Provide lineNumber with fullCancellation: false
Single line by ID: Provide lineId with fullCancellation: false
Multiple lines: Use allLineIds with comma-separated line IDs

Required Fields: orderNumber, businessUnit, reasonCode

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderId

int64

required

Numeric ID of the order to be terminated. Must correspond to the orderNumber provided in the request body.

Body Params

Termination request details. The orderNumber in the body must match the order associated with the orderId path parameter.

Request body for order termination/cancellation. Contains both termination-specific fields and base amendment fields inherited from AmendmentOrderRESTRequest.

orderNumber

string

required

length ≥ 1

Order number to be terminated. Must match the order associated with the provided orderId path parameter. Required field.

businessUnit

string

required

length ≥ 1

Business unit responsible for the order. Must be a valid, non-empty business unit code configured in RecVue. Required field.

reasonCode

string

required

length ≥ 1

Reason code for the termination. Must be a valid, non-empty reason code configured in RecVue. Required field.

orgId

int64

Organization ID associated with the order.

internalNotes

string

Internal notes or comments about the termination reason. Not visible to the customer.

orderOnHold

string

enum

Flag indicating whether the order should be placed on hold during termination processing.

Allowed:

amendmentId

int64

ID of an existing amendment to associate with this termination. Used when updating or resubmitting an existing draft amendment.

tenantId

int64

Tenant ID for multi-tenant environments. Identifies the tenant context for this request.

SupplierCreditList

array of objects

List of supplier credit entries to be applied as part of the termination. Required when enableSupplierTab is Y.

SupplierCreditList

cancelDate

date

Effective cancellation date in yyyy-MM-dd format. The date on which the order termination becomes effective.

cancelFees

double

Cancellation fees to be charged to the customer upon order termination.

creditAmount

double

Manually specified credit amount to issue to the customer. Used when overriding the auto-calculated prorated credit.

lineNumber

double

Specific order line number to terminate. When provided with fullCancellation: false, only the specified line is terminated instead of the entire order.

extReferenceNumber

string

External reference number for cross-system tracking and reconciliation of the termination request.

fullCancellation

boolean

Defaults to false

Controls the scope of termination. true: Cancel the entire order including all lines. false: Partial termination; use lineNumber or lineId to specify which line to terminate. Defaults to false.

creditMethod

string

enum

Method used to calculate the credit amount for the terminated period. PRORATE: Credit is prorated based on unused billing period. FULL: Full credit is issued for the remaining period. NONE: No credit is issued.

Allowed:

creditType

string

Credit type determining how the credit is processed. Typical values: AUTO (credit automatically applied to account), MANUAL (credit requires manual approval before application).

contingency

string

Contingency flag for special termination handling scenarios. Used for conditional processing rules defined in RecVue configuration.

processAmendment

boolean

Defaults to true

Controls whether the amendment is processed immediately after submission. Set to false to create the amendment record without processing. Defaults to true.

calculateCredit

string

enum

Instructs the system to automatically calculate the credit amount based on creditMethod and cancelDate. Y: Auto-calculate credit. N: Skip automatic credit calculation (use creditAmount for manual override).

Allowed:

fullCredit

string

enum

Flag to issue full credit for the entire remaining billing period without proration. Y: Issue full credit. N: Do not apply full credit override (use creditMethod instead).

Allowed:

noCredit

string

enum

Flag to terminate the order without issuing any credit to the customer. Takes precedence over creditMethod when set to Y. Y: No credit issued. N: Credit determined by creditMethod.

Allowed:

action

string

enum

Controls the processing mode for the termination request. SAVE: Creates a draft amendment record without processing (for review/approval). SUBMIT: Submits the amendment through the approval workflow. Omit or leave blank to process the termination immediately without creating an amendment.

Allowed:

batchAction

string

Batch action flag used when the termination is part of a bulk or batch processing operation. Identifies the batch operation type.

lastBilledDate

date-time

The last date on which the order was billed. Used as a reference point in prorated credit calculations to determine the unbilled period.

terminationDate

date-time

The actual termination date for the order. May differ from cancelDate in scenarios where billing periods span the cancellation date.

totalBilledAmount

double

Total amount already billed for the order up to the termination date. Used as a reference for credit calculation validation.

pendingAdjustmentAmount

double

Amount of pending adjustments that must be factored into the termination credit calculation. Affects the net credit amount issued.

enableSupplierTab

string

enum

Flag to enable supplier credit processing during termination. When set to Y, the SupplierCreditList is required and processed. Y: Enable supplier credits. N: Skip supplier credit processing.

Allowed:

lineId

string

Unique system identifier of the specific order line to terminate. Alternative to lineNumber for identifying a single line. Use for partial termination when the line ID is known.

userId

int64

ID of the user initiating the termination request. Used for audit logging and approval workflow assignment.

requestId

int64

Unique ID for tracking this termination request across systems. Used for referencing the request in subsequent operations or status checks.

batchId

int64

Batch ID when this termination is part of a batch processing operation. Links this request to a parent batch job.

cascade

string

Cascade flag that controls whether the termination cascades to dependent records such as child orders, related subscriptions, or linked order lines.

effectiveDate

date-time

Effective date for the amendment record. Determines when the termination amendment takes effect within the billing and revenue recognition systems.

allLineIds

string

Comma-separated list of order line IDs to terminate simultaneously in a single request. Used for bulk partial termination of multiple specific lines within the same order. Mutually exclusive with lineNumber/lineId for single-line termination.

Responses

400

Bad Request — Invalid input parameters, missing required fields (orderNumber, businessUnit, reasonCode), or orderNumber does not match the provided orderId.

401

Unauthorized — Missing or invalid authentication token (X-Forwarded-User header).

403

Forbidden — The authenticated user does not have sufficient permissions to terminate this order.

404

Not Found — No order exists with the specified orderId.

500

Internal Server Error — An unexpected error occurred during termination processing.

200Order terminated successfully. Returns status code, message, and the amendment ID (when action is SAVE or SUBMIT).