WebAPI

<back to all web services

GetInvoices

The following routes are available for this service:
POST/GetInvoicesRESTFUL POST call with Account ID , Start and End Dates, 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/GetInvoices 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,
	SearchInvoiceNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Invoices: 
	[
		{
			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,
			IsPaid: False,
			PaidDate: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	TotalNumber: 0
}