TipaltiPayerSOAPV5 Web Service

TipaltiPayerSOAPV5

Click here for a complete list of operations.

ApplyVendorCredit

Applies vendor credit for related bills

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v5/PayerFunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Tipalti.org/ApplyVendorCredit"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ApplyVendorCredit xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <vendorCreditRefCode>string</vendorCreditRefCode>
      <relatedInvoices>
        <RelatedInvoice>
          <InvoiceRefCode>string</InvoiceRefCode>
          <AppliedAmount>decimal</AppliedAmount>
        </RelatedInvoice>
        <RelatedInvoice>
          <InvoiceRefCode>string</InvoiceRefCode>
          <AppliedAmount>decimal</AppliedAmount>
        </RelatedInvoice>
      </relatedInvoices>
    </ApplyVendorCredit>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ApplyVendorCreditResponse xmlns="http://Tipalti.org/">
      <ApplyVendorCreditResult>
        <InvoiceResponses>
          <TipaltiApplyVendorCreditItemResponse>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiApplyVendorCreditItemResponse>
          <TipaltiApplyVendorCreditItemResponse>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiApplyVendorCreditItemResponse>
        </InvoiceResponses>
        <VendorCreditResponse>
          <ErrorMessage>string</ErrorMessage>
          <Succeeded>boolean</Succeeded>
          <InvoiceRefCode>string</InvoiceRefCode>
        </VendorCreditResponse>
      </ApplyVendorCreditResult>
    </ApplyVendorCreditResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v5/PayerFunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ApplyVendorCredit xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <vendorCreditRefCode>string</vendorCreditRefCode>
      <relatedInvoices>
        <RelatedInvoice>
          <InvoiceRefCode>string</InvoiceRefCode>
          <AppliedAmount>decimal</AppliedAmount>
        </RelatedInvoice>
        <RelatedInvoice>
          <InvoiceRefCode>string</InvoiceRefCode>
          <AppliedAmount>decimal</AppliedAmount>
        </RelatedInvoice>
      </relatedInvoices>
    </ApplyVendorCredit>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ApplyVendorCreditResponse xmlns="http://Tipalti.org/">
      <ApplyVendorCreditResult>
        <InvoiceResponses>
          <TipaltiApplyVendorCreditItemResponse>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiApplyVendorCreditItemResponse>
          <TipaltiApplyVendorCreditItemResponse>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiApplyVendorCreditItemResponse>
        </InvoiceResponses>
        <VendorCreditResponse>
          <ErrorMessage>string</ErrorMessage>
          <Succeeded>boolean</Succeeded>
          <InvoiceRefCode>string</InvoiceRefCode>
        </VendorCreditResponse>
      </ApplyVendorCreditResult>
    </ApplyVendorCreditResponse>
  </soap12:Body>
</soap12:Envelope>