Affluenza REST API

<back to all web services

GetSettlementReportRequest

The following routes are available for this service:
POST, GET/reports/settlement

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetSettlementReportRequest HTTP/1.1 
Host: 107.22.237.214 
Content-Type: application/json
Content-Length: length

{"portfolios":["String"],"portfolioId":"00000000000000000000000000000000","startDate":"0001-01-01T00:00:00.0000000","endDate":"0001-01-01T00:00:00.0000000","displayCurrency":"String","basePortfolioName":"String","exportToSAP":false,"simulation":false,"appKey":0,"token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":"Success","response":{"startDate":"0001-01-01T00:00:00.0000000","endDate":"0001-01-01T00:00:00.0000000","displayCurrencyTicker":{"ticker":"String","description":"String"},"basePortfolioName":"String","portfolios":[{"id":"00000000000000000000000000000000","parentId":"00000000000000000000000000000000","name":"String","notional":0,"averageMaturity":0,"markToMarket":0,"accrual":0,"internalReturnRate":0,"duration":0,"outstandingBalance":0,"deep":0,"portfolios":[{"id":"00000000000000000000000000000000","parentId":"00000000000000000000000000000000","name":"String","notional":0,"averageMaturity":0,"markToMarket":0,"accrual":0,"internalReturnRate":0,"duration":0,"outstandingBalance":0,"deep":0,"portfolios":[{"id":"00000000000000000000000000000000","parentId":"00000000000000000000000000000000","name":"String","notional":0,"averageMaturity":0,"markToMarket":0,"accrual":0,"internalReturnRate":0,"duration":0,"outstandingBalance":0,"deep":0}]}]}],"bonds":[{"id":"00000000000000000000000000000000","portfolioId":"00000000000000000000000000000000","contractCategory":{"ticker":"String","type":"String","description":"String"},"contractId":"String","counterParty":"String","notional":0,"underlying":{"ticker":"String","description":"String"},"instrument":{"ticker":"String","description":"String"},"cashFlowIndexPercentage":0,"cashFlowInterestRate":0,"startDate":"0001-01-01T00:00:00.0000000","maturityDate":"0001-01-01T00:00:00.0000000","numberOfPayments":0,"settlementCurrency":{"ticker":"String","description":"String"},"accrualValue":0,"duration":0,"internalReturnRate":0,"markToMarket":0,"feeUpFront":0,"iof":0,"observation":"String","warrantyType":"String","warrantyInformation":"String","externalKey":"String","termConvention":"String","hedgeAccounting":{"ticker":"String","description":"String","active":false},"settlementQuotationInitialValue":0,"origin":"String","contractWarrantyValue":0,"feeDeferredType":"String","iofDeferredType":"String"}],"derivatives":[{"id":"00000000000000000000000000000000","portfolioId":"00000000000000000000000000000000","contractCategory":{"ticker":"String","type":"String","description":"String"},"contractCurrency":{"ticker":"String","description":"String"},"contractId":"String","counterParty":"String","notional":0,"instrument":{"ticker":"String","description":"String"},"underlying":{"ticker":"String","description":"String"},"settlementCurrency":{"ticker":"String","description":"String"},"forwardValue":0,"position":{"type":"String","description":"String"},"forwardMarketValue":0,"settlementExchangeCurrency":0,"hedgeAccounting":{"ticker":"String","description":"String","active":false},"riskFreeRate":0,"startDate":"0001-01-01T00:00:00.0000000","maturityDate":"0001-01-01T00:00:00.0000000","markToMarket":0,"observation":"String","warrantyType":"String","warrantyInformation":"String","externalKey":"String","dataSource":"String","contractFixing":{"ticker":"String","description":"String"},"details":[{"number":0,"date":"0001-01-01T00:00:00.0000000","forwardMarketValue":0,"forwardValue":0,"markToMarket":0,"notional":0,"riskFreeRate":0,"settlementExchangeCurrency":0}]}]},"errorMessage":{"message":"String","statusCode":0}}