This web service updates the payment status of an issued invoice.

Request

The service request contains:

UpdateInvoicePaymentStatusRequest
Name	Data Type	Required?	Default Value	Discussion
InvoiceNumber	String(20)	yes		Number of the invoice to be modified; only issued invoice can have payment status updated. If invoice is of draft or approved status, error 61048 is triggered.
PaidFlag	Boolean	yes		True to mark invoice as paid, false to mark it not paid.
PaymentComment	String(1000)	no		Only specify if marking invoice paid; if supplied when PaidFlag is false, error 50406 is triggered.
InvoiceTimestamp	String	no		Optional; specified for optimistic locking

Request Usage Example(s)

Example 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://www.opsplanning.com/webservices/public/data">
   <soapenv:Header>
      <data:OpsAuthenticationHeader>
         <!--Optional:-->
         <data:AccountName>Revcorp-min</data:AccountName>
         <!--Optional:-->
         <data:EmailAddress>larry@revcorp.min</data:EmailAddress>
         <!--Optional:-->
         <data:Password>LaDiDa</data:Password>
      </data:OpsAuthenticationHeader>
   </soapenv:Header>
   <soapenv:Body>
      <data:UpdateInvoicePaymentStatus>
         <!--Optional:-->
         <data:request>
            <!--Optional:-->
            <data:Parameters>
               <!--Optional:-->
               <data:InvoiceNumber>INV00110</data:InvoiceNumber>
               <data:PaidFlag>true</data:PaidFlag>
               <data:PaymentComment>Client just mailed in the check</data:PaymentComment>
            </data:Parameters>
         </data:request>
      </data:UpdateInvoicePaymentStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response

The following data is returned:

UpdateInvoicePaymentStatusResponse
Name	Data Type	Discussion
InvoiceTimestamp	string	Invoice optimistic locking timestamp

Response Usage Example(s)

Example 01

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <UpdateInvoicePaymentStatusResponse xmlns="http://www.opsplanning.com/webservices/public/data">
         <UpdateInvoicePaymentStatusResult>
            <Result>Ok</Result>
            <Errors/>
            <Data>
               <InvoiceTimestamp>AAAAABLXruQ=</InvoiceTimestamp>
            </Data>
         </UpdateInvoicePaymentStatusResult>
      </UpdateInvoicePaymentStatusResponse>
   </soap:Body>
</soap:Envelope>