TipaltiPayerSOAPV5 Web Service

TipaltiPayerSOAPV5

Click here for a complete list of operations.

CreateOrUpdatePurchaseOrders

Create new purchase orders or update existing ones.
EAT - null

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/CreateOrUpdatePurchaseOrders"

<?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>
    <CreateOrUpdatePurchaseOrders xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <purchaseOrders>
        <TipaltiPurchaseOrderItem>
          <Idap>string</Idap>
          <PurchaseOrderNumber>string</PurchaseOrderNumber>
          <Status>Active or Closed or Deleted or PartiallyBilled or PendingApproval</Status>
          <Memo>string</Memo>
          <PurchaseOrderDate>dateTime</PurchaseOrderDate>
          <PayerEntity>string</PayerEntity>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <PurchaseOrderLines>
            <PurchaseOrderLine xsi:nil="true" />
            <PurchaseOrderLine xsi:nil="true" />
          </PurchaseOrderLines>
          <OldPurchaseOrderNumber>string</OldPurchaseOrderNumber>
        </TipaltiPurchaseOrderItem>
        <TipaltiPurchaseOrderItem>
          <Idap>string</Idap>
          <PurchaseOrderNumber>string</PurchaseOrderNumber>
          <Status>Active or Closed or Deleted or PartiallyBilled or PendingApproval</Status>
          <Memo>string</Memo>
          <PurchaseOrderDate>dateTime</PurchaseOrderDate>
          <PayerEntity>string</PayerEntity>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <PurchaseOrderLines>
            <PurchaseOrderLine xsi:nil="true" />
            <PurchaseOrderLine xsi:nil="true" />
          </PurchaseOrderLines>
          <OldPurchaseOrderNumber>string</OldPurchaseOrderNumber>
        </TipaltiPurchaseOrderItem>
      </purchaseOrders>
    </CreateOrUpdatePurchaseOrders>
  </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>
    <CreateOrUpdatePurchaseOrdersResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdatePurchaseOrdersResult>
        <PurchaseOrderErrors>
          <TipaltiPurchaseOrderItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <PurchaseOrderNumber>string</PurchaseOrderNumber>
          </TipaltiPurchaseOrderItemResult>
          <TipaltiPurchaseOrderItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <PurchaseOrderNumber>string</PurchaseOrderNumber>
          </TipaltiPurchaseOrderItemResult>
        </PurchaseOrderErrors>
      </CreateOrUpdatePurchaseOrdersResult>
    </CreateOrUpdatePurchaseOrdersResponse>
  </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>
    <CreateOrUpdatePurchaseOrders xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <purchaseOrders>
        <TipaltiPurchaseOrderItem>
          <Idap>string</Idap>
          <PurchaseOrderNumber>string</PurchaseOrderNumber>
          <Status>Active or Closed or Deleted or PartiallyBilled or PendingApproval</Status>
          <Memo>string</Memo>
          <PurchaseOrderDate>dateTime</PurchaseOrderDate>
          <PayerEntity>string</PayerEntity>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <PurchaseOrderLines>
            <PurchaseOrderLine xsi:nil="true" />
            <PurchaseOrderLine xsi:nil="true" />
          </PurchaseOrderLines>
          <OldPurchaseOrderNumber>string</OldPurchaseOrderNumber>
        </TipaltiPurchaseOrderItem>
        <TipaltiPurchaseOrderItem>
          <Idap>string</Idap>
          <PurchaseOrderNumber>string</PurchaseOrderNumber>
          <Status>Active or Closed or Deleted or PartiallyBilled or PendingApproval</Status>
          <Memo>string</Memo>
          <PurchaseOrderDate>dateTime</PurchaseOrderDate>
          <PayerEntity>string</PayerEntity>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <PurchaseOrderLines>
            <PurchaseOrderLine xsi:nil="true" />
            <PurchaseOrderLine xsi:nil="true" />
          </PurchaseOrderLines>
          <OldPurchaseOrderNumber>string</OldPurchaseOrderNumber>
        </TipaltiPurchaseOrderItem>
      </purchaseOrders>
    </CreateOrUpdatePurchaseOrders>
  </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>
    <CreateOrUpdatePurchaseOrdersResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdatePurchaseOrdersResult>
        <PurchaseOrderErrors>
          <TipaltiPurchaseOrderItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <PurchaseOrderNumber>string</PurchaseOrderNumber>
          </TipaltiPurchaseOrderItemResult>
          <TipaltiPurchaseOrderItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <PurchaseOrderNumber>string</PurchaseOrderNumber>
          </TipaltiPurchaseOrderItemResult>
        </PurchaseOrderErrors>
      </CreateOrUpdatePurchaseOrdersResult>
    </CreateOrUpdatePurchaseOrdersResponse>
  </soap12:Body>
</soap12:Envelope>