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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/GetInvoiceRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: text/csv
Content-Length: length

IsMagentoOrderNumber,Reference
False,String

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

Pdfs,MagentoReference,CustomerName,CustomerEmailAddress,Invoices
[String],String,String,String,"[{invoiceReference:String,invoiceDateTime:String,totalPaymentAmount:String,totalVatAmount:String}]"