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

HTTP + XML

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

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

<GetInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.KSP">
  <IsMagentoOrderNumber>false</IsMagentoOrderNumber>
  <Reference>String</Reference>
</GetInvoiceRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.KSP">
  <CustomerEmailAddress>String</CustomerEmailAddress>
  <CustomerName>String</CustomerName>
  <Invoices>
    <Invoice>
      <InvoiceDateTime>String</InvoiceDateTime>
      <InvoiceReference>String</InvoiceReference>
      <TotalPaymentAmount>String</TotalPaymentAmount>
      <TotalVatAmount>String</TotalVatAmount>
    </Invoice>
  </Invoices>
  <MagentoReference>String</MagentoReference>
  <Pdfs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Pdfs>
</GetInvoiceResponse>