TicketUserServices

RunRecurringChargeJobRequest

**Requires Authentication**
Requires the role:	Admin

The following routes are available for this service:
POST	/recurringPayments/run-charge


export class RecurringChargeJobSummary
{
    public masterEnabled?: boolean;
    public autoSubmitEnabled?: boolean;
    public dunningEnabled?: boolean;
    public expireLapsedEnabled?: boolean;
    public endOfTermRevokeEnabled?: boolean;
    public chargeHour?: number;
    public batchSize?: number;
    public asOfUtc?: string;
    public dryRun?: boolean;
    public chargeLive?: boolean;
    public dunningLive?: boolean;
    public charged?: number;
    public declined?: number;
    public ambiguous?: number;
    public skippedAlreadyCharged?: number;
    public nullOwnerCharged?: number;
    public skippedSinglePayment?: number;
    public expiredCards?: number;
    public endOfTermClosed?: number;
    public endOfTermRevoked?: number;
    public hardClosed?: number;
    public cappedClosed?: number;
    public expiredCardNotified?: number;
    public checkFirst?: number;
    public circuitBroken?: boolean;
    public circuitBreakerCode?: string;
    public wouldCharge?: number;
    public wouldStopHard?: number;
    public wouldStopCapped?: number;
    public wouldSms?: number;
    public wouldEmail?: number;
    public wouldClose?: number;
    public wouldExpire?: number;
    public wouldEndOfTermClose?: number;
    public wouldEndOfTermRevoke?: number;
    public smsSent?: number;
    public emails?: number;
    public closed?: number;
    public log?: string[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<RecurringChargeJobSummary>) { (Object as any).assign(this, init); }
}

export class RunRecurringChargeJobRequest
{
    public dryRun?: boolean;
    public asOf?: string;

    public constructor(init?: Partial<RunRecurringChargeJobRequest>) { (Object as any).assign(this, init); }
}

TypeScript RunRecurringChargeJobRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recurringPayments/run-charge HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	dryRun: False,
	asOf: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	masterEnabled: False,
	autoSubmitEnabled: False,
	dunningEnabled: False,
	expireLapsedEnabled: False,
	endOfTermRevokeEnabled: False,
	chargeHour: 0,
	batchSize: 0,
	asOfUtc: 0001-01-01,
	dryRun: False,
	chargeLive: False,
	dunningLive: False,
	charged: 0,
	declined: 0,
	ambiguous: 0,
	skippedAlreadyCharged: 0,
	nullOwnerCharged: 0,
	skippedSinglePayment: 0,
	expiredCards: 0,
	endOfTermClosed: 0,
	endOfTermRevoked: 0,
	hardClosed: 0,
	cappedClosed: 0,
	expiredCardNotified: 0,
	checkFirst: 0,
	circuitBroken: False,
	circuitBreakerCode: String,
	wouldCharge: 0,
	wouldStopHard: 0,
	wouldStopCapped: 0,
	wouldSms: 0,
	wouldEmail: 0,
	wouldClose: 0,
	wouldExpire: 0,
	wouldEndOfTermClose: 0,
	wouldEndOfTermRevoke: 0,
	smsSent: 0,
	emails: 0,
	closed: 0,
	log: 
	[
		String
	],
	statusCode: 0,
	message: String
}