s1 API Host

<back to all web services

GetInvoiceRequest

The following routes are available for this service:
GET, OPTIONS/api/ksp/invoiceGet invoice by order id or invoice id Only possible if the user is authenticated
Parameters:
NameParameterData TypeRequiredDescription
IsMagentoOrderNumberqueryboolYesIs reference an order number
ReferencequerystringYesReference for retrieving one or more invoices

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/GetInvoiceRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: text/jsv
Content-Length: length

{
	isMagentoOrderNumber: False,
	reference: String
}

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

{
	pdfs: 
	[
		String
	],
	magentoReference: String,
	customerName: String,
	customerEmailAddress: String,
	invoices: 
	[
		{
			invoiceReference: String,
			invoiceDateTime: String,
			totalPaymentAmount: String,
			totalVatAmount: String
		}
	]
}