TipaltiPayerSOAPV5 Web Service

TipaltiPayerSOAPV5

Click here for a complete list of operations.

CreateOrUpdateInvoices

create new invoices 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/CreateOrUpdateInvoices"

<?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>
    <CreateOrUpdateInvoices xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <invoices>
        <TipaltiInvoiceItemRequest>
          <Idap>string</Idap>
          <InvoiceRefCode>string</InvoiceRefCode>
          <InvoiceDate>dateTime</InvoiceDate>
          <InvoiceDueDate>dateTime</InvoiceDueDate>
          <InvoiceLines>
            <InvoiceLine xsi:nil="true" />
            <InvoiceLine xsi:nil="true" />
          </InvoiceLines>
          <Description>string</Description>
          <CanApprove>boolean</CanApprove>
          <InvoiceInternalNotes>string</InvoiceInternalNotes>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IsPaidManually>boolean</IsPaidManually>
          <IncomeType>string</IncomeType>
          <InvoiceStatus>PendingApReview or PendingApproval or PendingApAction or PendingPayment or SubmittedForPayment or Paid or Disputed or Deleted or PendingPayeeApproval or PendingPayeeInvoice or PartiallyPaid or ScheduledForPayment or ReviewMatching or PendingMatching</InvoiceStatus>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <InvoiceNumber>string</InvoiceNumber>
          <PayerEntityName>string</PayerEntityName>
          <InvoiceSubject>string</InvoiceSubject>
          <ApAccountNumber>string</ApAccountNumber>
          <ApAccountExternalId>string</ApAccountExternalId>
          <VatValue>string</VatValue>
          <ManualPaymentDetails>
            <GLAccountExternalId>string</GLAccountExternalId>
            <TransactionDate>dateTime</TransactionDate>
          </ManualPaymentDetails>
          <PurchaseOrderNumbers>
            <string>string</string>
            <string>string</string>
          </PurchaseOrderNumbers>
        </TipaltiInvoiceItemRequest>
        <TipaltiInvoiceItemRequest>
          <Idap>string</Idap>
          <InvoiceRefCode>string</InvoiceRefCode>
          <InvoiceDate>dateTime</InvoiceDate>
          <InvoiceDueDate>dateTime</InvoiceDueDate>
          <InvoiceLines>
            <InvoiceLine xsi:nil="true" />
            <InvoiceLine xsi:nil="true" />
          </InvoiceLines>
          <Description>string</Description>
          <CanApprove>boolean</CanApprove>
          <InvoiceInternalNotes>string</InvoiceInternalNotes>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IsPaidManually>boolean</IsPaidManually>
          <IncomeType>string</IncomeType>
          <InvoiceStatus>PendingApReview or PendingApproval or PendingApAction or PendingPayment or SubmittedForPayment or Paid or Disputed or Deleted or PendingPayeeApproval or PendingPayeeInvoice or PartiallyPaid or ScheduledForPayment or ReviewMatching or PendingMatching</InvoiceStatus>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <InvoiceNumber>string</InvoiceNumber>
          <PayerEntityName>string</PayerEntityName>
          <InvoiceSubject>string</InvoiceSubject>
          <ApAccountNumber>string</ApAccountNumber>
          <ApAccountExternalId>string</ApAccountExternalId>
          <VatValue>string</VatValue>
          <ManualPaymentDetails>
            <GLAccountExternalId>string</GLAccountExternalId>
            <TransactionDate>dateTime</TransactionDate>
          </ManualPaymentDetails>
          <PurchaseOrderNumbers>
            <string>string</string>
            <string>string</string>
          </PurchaseOrderNumbers>
        </TipaltiInvoiceItemRequest>
      </invoices>
    </CreateOrUpdateInvoices>
  </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>
    <CreateOrUpdateInvoicesResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdateInvoicesResult>
        <InvoiceErrors>
          <TipaltiInvoiceItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiInvoiceItemResult>
          <TipaltiInvoiceItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiInvoiceItemResult>
        </InvoiceErrors>
      </CreateOrUpdateInvoicesResult>
    </CreateOrUpdateInvoicesResponse>
  </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>
    <CreateOrUpdateInvoices xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <invoices>
        <TipaltiInvoiceItemRequest>
          <Idap>string</Idap>
          <InvoiceRefCode>string</InvoiceRefCode>
          <InvoiceDate>dateTime</InvoiceDate>
          <InvoiceDueDate>dateTime</InvoiceDueDate>
          <InvoiceLines>
            <InvoiceLine xsi:nil="true" />
            <InvoiceLine xsi:nil="true" />
          </InvoiceLines>
          <Description>string</Description>
          <CanApprove>boolean</CanApprove>
          <InvoiceInternalNotes>string</InvoiceInternalNotes>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IsPaidManually>boolean</IsPaidManually>
          <IncomeType>string</IncomeType>
          <InvoiceStatus>PendingApReview or PendingApproval or PendingApAction or PendingPayment or SubmittedForPayment or Paid or Disputed or Deleted or PendingPayeeApproval or PendingPayeeInvoice or PartiallyPaid or ScheduledForPayment or ReviewMatching or PendingMatching</InvoiceStatus>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <InvoiceNumber>string</InvoiceNumber>
          <PayerEntityName>string</PayerEntityName>
          <InvoiceSubject>string</InvoiceSubject>
          <ApAccountNumber>string</ApAccountNumber>
          <ApAccountExternalId>string</ApAccountExternalId>
          <VatValue>string</VatValue>
          <ManualPaymentDetails>
            <GLAccountExternalId>string</GLAccountExternalId>
            <TransactionDate>dateTime</TransactionDate>
          </ManualPaymentDetails>
          <PurchaseOrderNumbers>
            <string>string</string>
            <string>string</string>
          </PurchaseOrderNumbers>
        </TipaltiInvoiceItemRequest>
        <TipaltiInvoiceItemRequest>
          <Idap>string</Idap>
          <InvoiceRefCode>string</InvoiceRefCode>
          <InvoiceDate>dateTime</InvoiceDate>
          <InvoiceDueDate>dateTime</InvoiceDueDate>
          <InvoiceLines>
            <InvoiceLine xsi:nil="true" />
            <InvoiceLine xsi:nil="true" />
          </InvoiceLines>
          <Description>string</Description>
          <CanApprove>boolean</CanApprove>
          <InvoiceInternalNotes>string</InvoiceInternalNotes>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IsPaidManually>boolean</IsPaidManually>
          <IncomeType>string</IncomeType>
          <InvoiceStatus>PendingApReview or PendingApproval or PendingApAction or PendingPayment or SubmittedForPayment or Paid or Disputed or Deleted or PendingPayeeApproval or PendingPayeeInvoice or PartiallyPaid or ScheduledForPayment or ReviewMatching or PendingMatching</InvoiceStatus>
          <Currency>string</Currency>
          <Approvers>
            <TipaltiInvoiceApprover xsi:nil="true" />
            <TipaltiInvoiceApprover xsi:nil="true" />
          </Approvers>
          <InvoiceNumber>string</InvoiceNumber>
          <PayerEntityName>string</PayerEntityName>
          <InvoiceSubject>string</InvoiceSubject>
          <ApAccountNumber>string</ApAccountNumber>
          <ApAccountExternalId>string</ApAccountExternalId>
          <VatValue>string</VatValue>
          <ManualPaymentDetails>
            <GLAccountExternalId>string</GLAccountExternalId>
            <TransactionDate>dateTime</TransactionDate>
          </ManualPaymentDetails>
          <PurchaseOrderNumbers>
            <string>string</string>
            <string>string</string>
          </PurchaseOrderNumbers>
        </TipaltiInvoiceItemRequest>
      </invoices>
    </CreateOrUpdateInvoices>
  </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>
    <CreateOrUpdateInvoicesResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdateInvoicesResult>
        <InvoiceErrors>
          <TipaltiInvoiceItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiInvoiceItemResult>
          <TipaltiInvoiceItemResult>
            <ErrorMessage>string</ErrorMessage>
            <Succeeded>boolean</Succeeded>
            <InvoiceRefCode>string</InvoiceRefCode>
          </TipaltiInvoiceItemResult>
        </InvoiceErrors>
      </CreateOrUpdateInvoicesResult>
    </CreateOrUpdateInvoicesResponse>
  </soap12:Body>
</soap12:Envelope>