Veetro Web Service Methods Web Service

Veetro Web Service Methods

Click here for a complete list of operations.

GetInvoiceSearchResults2

[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Returns invoice search results

Test

The test form is only available for requests from the local machine.

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetInvoiceSearchResults2"

<?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>
    <GetInvoiceSearchResults2 xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Sort>InvoiceID or DateCreated or DateLastModified or Relation or DateDue or Total or Balance or Currency or DatePaid or LeadNameReadOnly or InvoiceCode</Sort>
        <Ascending>boolean</Ascending>
        <Relation>int</Relation>
        <Filter>Any or Paid or Unpaid or Quotes or CancelledInvoices or CancelledQuotes</Filter>
        <Keywords>string</Keywords>
        <Type>Bill or Quote or Credit</Type>
      </e>
    </GetInvoiceSearchResults2>
  </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>
    <GetInvoiceSearchResults2Response xmlns="http://schema.veetro.com">
      <GetInvoiceSearchResults2Result>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Invoice>
            <InvoiceID>int</InvoiceID>
            <SequenceNum>int</SequenceNum>
            <InvoiceCode>string</InvoiceCode>
            <TemplateID>int</TemplateID>
            <LeadID>int</LeadID>
            <EntryID>int</EntryID>
            <FirstMailQueueID>int</FirstMailQueueID>
            <FirstMessageStatus>Enqueued or Sent or Error or DeliveryDelayed or DeliveryFailed or RecipientOpened or DeliverySuppressed</FirstMessageStatus>
            <DateCreated>dateTime</DateCreated>
            <CurrencyIso4217>string</CurrencyIso4217>
            <Rounding xsi:nil="true" />
            <DateLastModified>dateTime</DateLastModified>
            <DateDue>dateTime</DateDue>
            <DatePaid>dateTime</DatePaid>
            <Items xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <BillTo xsi:nil="true" />
            <BillToName>string</BillToName>
            <ShipTo xsi:nil="true" />
            <ShipToName>string</ShipToName>
            <Memo>string</Memo>
            <PONumber>string</PONumber>
            <Creator xsi:nil="true" />
            <Balance>double</Balance>
            <Total>double</Total>
            <Locked>boolean</Locked>
            <TaxInclusive>boolean</TaxInclusive>
            <Adjustments xsi:nil="true" />
            <IsQuote>boolean</IsQuote>
            <Type>Bill or Quote or Credit</Type>
            <Flags>None or UseBusinessNumberFormatting or IsCancelled</Flags>
            <Tag>string</Tag>
            <LastPaymentErrorDate>dateTime</LastPaymentErrorDate>
            <LastPaymentError>string</LastPaymentError>
            <TaxSummariesReadOnly xsi:nil="true" />
            <LeadNameReadOnly>string</LeadNameReadOnly>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </Invoice>
          <Invoice>
            <InvoiceID>int</InvoiceID>
            <SequenceNum>int</SequenceNum>
            <InvoiceCode>string</InvoiceCode>
            <TemplateID>int</TemplateID>
            <LeadID>int</LeadID>
            <EntryID>int</EntryID>
            <FirstMailQueueID>int</FirstMailQueueID>
            <FirstMessageStatus>Enqueued or Sent or Error or DeliveryDelayed or DeliveryFailed or RecipientOpened or DeliverySuppressed</FirstMessageStatus>
            <DateCreated>dateTime</DateCreated>
            <CurrencyIso4217>string</CurrencyIso4217>
            <Rounding xsi:nil="true" />
            <DateLastModified>dateTime</DateLastModified>
            <DateDue>dateTime</DateDue>
            <DatePaid>dateTime</DatePaid>
            <Items xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <BillTo xsi:nil="true" />
            <BillToName>string</BillToName>
            <ShipTo xsi:nil="true" />
            <ShipToName>string</ShipToName>
            <Memo>string</Memo>
            <PONumber>string</PONumber>
            <Creator xsi:nil="true" />
            <Balance>double</Balance>
            <Total>double</Total>
            <Locked>boolean</Locked>
            <TaxInclusive>boolean</TaxInclusive>
            <Adjustments xsi:nil="true" />
            <IsQuote>boolean</IsQuote>
            <Type>Bill or Quote or Credit</Type>
            <Flags>None or UseBusinessNumberFormatting or IsCancelled</Flags>
            <Tag>string</Tag>
            <LastPaymentErrorDate>dateTime</LastPaymentErrorDate>
            <LastPaymentError>string</LastPaymentError>
            <TaxSummariesReadOnly xsi:nil="true" />
            <LeadNameReadOnly>string</LeadNameReadOnly>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </Invoice>
        </Results>
      </GetInvoiceSearchResults2Result>
    </GetInvoiceSearchResults2Response>
  </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 /xml HTTP/1.1
Host: admin.worketc.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>
    <GetInvoiceSearchResults2 xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Sort>InvoiceID or DateCreated or DateLastModified or Relation or DateDue or Total or Balance or Currency or DatePaid or LeadNameReadOnly or InvoiceCode</Sort>
        <Ascending>boolean</Ascending>
        <Relation>int</Relation>
        <Filter>Any or Paid or Unpaid or Quotes or CancelledInvoices or CancelledQuotes</Filter>
        <Keywords>string</Keywords>
        <Type>Bill or Quote or Credit</Type>
      </e>
    </GetInvoiceSearchResults2>
  </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>
    <GetInvoiceSearchResults2Response xmlns="http://schema.veetro.com">
      <GetInvoiceSearchResults2Result>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Invoice>
            <InvoiceID>int</InvoiceID>
            <SequenceNum>int</SequenceNum>
            <InvoiceCode>string</InvoiceCode>
            <TemplateID>int</TemplateID>
            <LeadID>int</LeadID>
            <EntryID>int</EntryID>
            <FirstMailQueueID>int</FirstMailQueueID>
            <FirstMessageStatus>Enqueued or Sent or Error or DeliveryDelayed or DeliveryFailed or RecipientOpened or DeliverySuppressed</FirstMessageStatus>
            <DateCreated>dateTime</DateCreated>
            <CurrencyIso4217>string</CurrencyIso4217>
            <Rounding xsi:nil="true" />
            <DateLastModified>dateTime</DateLastModified>
            <DateDue>dateTime</DateDue>
            <DatePaid>dateTime</DatePaid>
            <Items xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <BillTo xsi:nil="true" />
            <BillToName>string</BillToName>
            <ShipTo xsi:nil="true" />
            <ShipToName>string</ShipToName>
            <Memo>string</Memo>
            <PONumber>string</PONumber>
            <Creator xsi:nil="true" />
            <Balance>double</Balance>
            <Total>double</Total>
            <Locked>boolean</Locked>
            <TaxInclusive>boolean</TaxInclusive>
            <Adjustments xsi:nil="true" />
            <IsQuote>boolean</IsQuote>
            <Type>Bill or Quote or Credit</Type>
            <Flags>None or UseBusinessNumberFormatting or IsCancelled</Flags>
            <Tag>string</Tag>
            <LastPaymentErrorDate>dateTime</LastPaymentErrorDate>
            <LastPaymentError>string</LastPaymentError>
            <TaxSummariesReadOnly xsi:nil="true" />
            <LeadNameReadOnly>string</LeadNameReadOnly>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </Invoice>
          <Invoice>
            <InvoiceID>int</InvoiceID>
            <SequenceNum>int</SequenceNum>
            <InvoiceCode>string</InvoiceCode>
            <TemplateID>int</TemplateID>
            <LeadID>int</LeadID>
            <EntryID>int</EntryID>
            <FirstMailQueueID>int</FirstMailQueueID>
            <FirstMessageStatus>Enqueued or Sent or Error or DeliveryDelayed or DeliveryFailed or RecipientOpened or DeliverySuppressed</FirstMessageStatus>
            <DateCreated>dateTime</DateCreated>
            <CurrencyIso4217>string</CurrencyIso4217>
            <Rounding xsi:nil="true" />
            <DateLastModified>dateTime</DateLastModified>
            <DateDue>dateTime</DateDue>
            <DatePaid>dateTime</DatePaid>
            <Items xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Owner xsi:nil="true" />
            <BillTo xsi:nil="true" />
            <BillToName>string</BillToName>
            <ShipTo xsi:nil="true" />
            <ShipToName>string</ShipToName>
            <Memo>string</Memo>
            <PONumber>string</PONumber>
            <Creator xsi:nil="true" />
            <Balance>double</Balance>
            <Total>double</Total>
            <Locked>boolean</Locked>
            <TaxInclusive>boolean</TaxInclusive>
            <Adjustments xsi:nil="true" />
            <IsQuote>boolean</IsQuote>
            <Type>Bill or Quote or Credit</Type>
            <Flags>None or UseBusinessNumberFormatting or IsCancelled</Flags>
            <Tag>string</Tag>
            <LastPaymentErrorDate>dateTime</LastPaymentErrorDate>
            <LastPaymentError>string</LastPaymentError>
            <TaxSummariesReadOnly xsi:nil="true" />
            <LeadNameReadOnly>string</LeadNameReadOnly>
            <Delete>boolean</Delete>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </Invoice>
        </Results>
      </GetInvoiceSearchResults2Result>
    </GetInvoiceSearchResults2Response>
  </soap12:Body>
</soap12:Envelope>