pixi Developer & Integration Documentation

pixiSetInvoicePaid

Description


Request Parameters

# Name Type Required Example Description
1 InvoiceNR string 1 DEM0000021 Invoice number of the invoice that should be set to paid
2 paid boolean 1 0 or 1 Set to paid =1 or unpaid =0
3 PaidDate string 0 YYYY-MM-DD hh:mm:ss Pay date and time when invoice is set to paid; If NULL, getdate() is used
4 eventID string 0 MIN The EventID of the payment event in Customer Account
5 PaidSum number 0 46.18 Sum that was paid. @CaptureSum in pixiPaySetInvoiceCapture; If (NULL) or =0 and @Paid=1, then completely paid

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiSetInvoicePaid>
         <dem:InvoiceNR>DEM0000021</dem:InvoiceNR>
         <dem:paid>0 or 1</dem:paid>
         <dem:PaidDate>YYYY-MM-DD hh:mm:ss</dem:PaidDate>
         <dem:eventID>MIN</dem:eventID>
         <dem:PaidSum>46.18</dem:PaidSum>
      </dem:pixiSetInvoicePaid>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Return status

# Name Type Description
1 Status string Result of API Call
2 Message string Extended Result of API Call

Additional Notes

API Call that sets entered Invoice (InvoiceNr) to paid or unpaid