VT_API Web Service

VT_API

Click here for a complete list of operations.

GetInvoicesForClient

Retrieves a list of invoices made out to a client

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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ozsoft.com.au/VETtrak/api/complete/GetInvoicesForClient"

<?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>
    <GetInvoicesForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <clientCode>string</clientCode>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <status>int</status>
    </GetInvoicesForClient>
  </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>
    <GetInvoicesForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetInvoicesForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <InvoiceList>
          <TInvoice>
            <InvoiceId>int</InvoiceId>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceeType>int</InvoiceeType>
            <InvoiceeIdentifier>string</InvoiceeIdentifier>
            <InvoiceeName>string</InvoiceeName>
            <OrderNumber>string</OrderNumber>
            <DueDate>dateTime</DueDate>
            <Description>string</Description>
            <PaymentStatus>int</PaymentStatus>
            <TotalAmount>decimal</TotalAmount>
            <TotalGST>decimal</TotalGST>
            <AmountPaid>decimal</AmountPaid>
            <InvoiceItems xsi:nil="true" />
            <OrganisationId>int</OrganisationId>
            <EmployerContact xsi:nil="true" />
          </TInvoice>
          <TInvoice>
            <InvoiceId>int</InvoiceId>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceeType>int</InvoiceeType>
            <InvoiceeIdentifier>string</InvoiceeIdentifier>
            <InvoiceeName>string</InvoiceeName>
            <OrderNumber>string</OrderNumber>
            <DueDate>dateTime</DueDate>
            <Description>string</Description>
            <PaymentStatus>int</PaymentStatus>
            <TotalAmount>decimal</TotalAmount>
            <TotalGST>decimal</TotalGST>
            <AmountPaid>decimal</AmountPaid>
            <InvoiceItems xsi:nil="true" />
            <OrganisationId>int</OrganisationId>
            <EmployerContact xsi:nil="true" />
          </TInvoice>
        </InvoiceList>
      </GetInvoicesForClientResult>
    </GetInvoicesForClientResponse>
  </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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.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>
    <GetInvoicesForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <clientCode>string</clientCode>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <status>int</status>
    </GetInvoicesForClient>
  </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>
    <GetInvoicesForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetInvoicesForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <InvoiceList>
          <TInvoice>
            <InvoiceId>int</InvoiceId>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceeType>int</InvoiceeType>
            <InvoiceeIdentifier>string</InvoiceeIdentifier>
            <InvoiceeName>string</InvoiceeName>
            <OrderNumber>string</OrderNumber>
            <DueDate>dateTime</DueDate>
            <Description>string</Description>
            <PaymentStatus>int</PaymentStatus>
            <TotalAmount>decimal</TotalAmount>
            <TotalGST>decimal</TotalGST>
            <AmountPaid>decimal</AmountPaid>
            <InvoiceItems xsi:nil="true" />
            <OrganisationId>int</OrganisationId>
            <EmployerContact xsi:nil="true" />
          </TInvoice>
          <TInvoice>
            <InvoiceId>int</InvoiceId>
            <InvoiceNumber>string</InvoiceNumber>
            <InvoiceDate>dateTime</InvoiceDate>
            <InvoiceeType>int</InvoiceeType>
            <InvoiceeIdentifier>string</InvoiceeIdentifier>
            <InvoiceeName>string</InvoiceeName>
            <OrderNumber>string</OrderNumber>
            <DueDate>dateTime</DueDate>
            <Description>string</Description>
            <PaymentStatus>int</PaymentStatus>
            <TotalAmount>decimal</TotalAmount>
            <TotalGST>decimal</TotalGST>
            <AmountPaid>decimal</AmountPaid>
            <InvoiceItems xsi:nil="true" />
            <OrganisationId>int</OrganisationId>
            <EmployerContact xsi:nil="true" />
          </TInvoice>
        </InvoiceList>
      </GetInvoicesForClientResult>
    </GetInvoicesForClientResponse>
  </soap12:Body>
</soap12:Envelope>