Affluenza REST API

<back to all web services

GetContractCashFlowsRequest

The following routes are available for this service:
POST,OPTIONS/contracts/cashFlows

To override the Content-type in your clients 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 /jsv/reply/GetContractCashFlowsRequest HTTP/1.1 
Host: 107.22.237.214 
Content-Type: text/jsv
Content-Length: length

{
	generationRule: Bullet,
	amortizationType: String,
	dateAdjustment: String,
	hasReset: False,
	indexerTicker: String,
	indexerCurrencyTicker: String,
	indexerPercentage: 0,
	baseValue: 0,
	indexStartDate: 0001-01-01,
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	amortizationThreshold: 0001-01-01,
	amortizationPeriodUnit: None,
	amortizationPeriodLength: 0,
	periodUnit: None,
	periodLength: 0,
	interestThreshold: 0001-01-01,
	interestPeriodUnit: None,
	interestPeriodLength: 0,
	termConvention: String,
	interestConvention: String,
	interestRate: 0,
	amortizationDates: 
	[
		String
	],
	amortizationPercentages: 
	[
		String
	],
	baseValueType: String,
	appKey: 0,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: Success,
	response: 
	[
		{
			id: 0,
			date: 0001-01-01,
			paymentDate: 0001-01-01,
			interest: 0,
			amortizationPercentage: 0,
			amortization: 0,
			total: 0
		}
	],
	errorMessage: 
	{
		message: String,
		statusCode: 0
	}
}