WebAPI

<back to all web services

GetStatements

Get account statement for the given account id with filters for start and end dates and page size limit.

The following routes are available for this service:
POST/GetStatementsRESTFUL call with Account ID and Page Size in the URI
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintegerYes
PageSizepathintegerYes
PageNumberpathintegerYes
SortingpathstringNo
StartDatepathstringNoYYYY-MM-DD
EndDatepathstringNoYYYY-MM-DD

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/GetStatements HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	AccountId: 0,
	PageSize: 0,
	PageNumber: 0,
	Sorting: String,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	SearchAmount: 0,
	SearchStatementNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Statements: 
	[
		{
			StatementId: 0,
			StatementNumber: String,
			StatementDate: 0001-01-01,
			Month: 0,
			Year: 0,
			Day: 0,
			PreviousBalance: 0,
			AmountDue: 0,
			TollFees: 0,
			OtherCharges: 0,
			Replenishments: 0,
			Balance: 0,
			BillingStartDate: 0001-01-01,
			BillingEndDate: 0001-01-01,
			DueDate: 0001-01-01,
			PaidDate: 0001-01-01
		}
	],
	TotalNumber: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}