List Estimates

Overview
Retrieve estimate List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/estimate/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user

Filter or Search Criteria

description	By estimate description
status	By status of estimate
externalId	By external ID of estimate
category	By cateogry of estimate
createdDateFrom	By created date of estimate
createdDateTo	By created date of estimate
dueDateFrom	By due date of estimate
dueDateTo	By due date of estimate

Return
Returns a list of estimate Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 estimates will be returned. Returns an error if not a valid request

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="requeest">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="description"/>
        <xs:element ref="status"/>
        <xs:element ref="category"/>
        <xs:element ref="createdDateFrom"/>
        <xs:element ref="createdDateTo"/>
        <xs:element ref="externalId"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="description" type="xs:string" minOccurs="0"/>
  <xs:element name="status" type="xs:NCName" minOccurs="0"/>
  <xs:element name="category" type="xs:integer" minOccurs="0"/>
  <xs:element name="createdDateFrom" type="xs:string" minOccurs="0"/>
  <xs:element name="createdDateTo" type="xs:string" minOccurs="0"/>
  <xs:element name="externalId" type="xs:string" minOccurs="0"/>
  <xs:element name="integrationStatus" type="xs:NCName" minOccurs="0"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="estimateList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="estimateList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element ref="estimate"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="estimate">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkEstimateId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="description"/>
        <xs:element ref="status"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="category"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="address"/>
        <xs:element ref="contact"/>
        <xs:element ref="customer"/>
        <xs:element ref="quoteNumber"/>
        <xs:element ref="dueDate"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="invoice"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkEstimateId" type="xs:integer"/>
  <xs:element name="category" type="xs:string"/>
  <xs:element name="assignedTo" type="xs:string"/>
  <xs:element name="contact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="contactId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="title"/>
        <xs:element ref="email"/>
        <xs:element ref="phoneNumber"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="officePhone"/>
        <xs:element ref="phoneExt"/>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="officePhoneExt"/>
        <xs:element ref="pin"/>
        <xs:element ref="enabled"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="fax"/>
        <xs:element ref="admin"/>
        <xs:element ref="employeeId"/>
        <xs:element ref="loginId"/>
        <xs:element ref="password"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="contactId" type="xs:integer"/>
  <xs:element name="phoneNumber" type="xs:integer"/>
  <xs:element name="officePhone">
    <xs:complexType/>
  </xs:element>
  <xs:element name="phoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="officePhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="pin" type="xs:integer"/>
  <xs:element name="admin" type="xs:boolean"/>
  <xs:element name="employeeId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="loginId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="password">
    <xs:complexType/>
  </xs:element>
  <xs:element name="customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customerId"/>
        <xs:element ref="status"/>
        <xs:element ref="address"/>
        <xs:element ref="companyName"/>
        <xs:element ref="externalCustomerId"/>
        <xs:element ref="primaryContact"/>
        <xs:element ref="taxable"/>
        <xs:element ref="typeId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="companyName" type="xs:string"/>
  <xs:element name="externalCustomerId" type="xs:integer"/>
  <xs:element name="primaryContact">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="altPhoneExt"/>
        <xs:element ref="altPhoneNumber"/>
        <xs:element ref="email"/>
        <xs:element ref="fax"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="PhoneExt"/>
        <xs:element ref="PhoneNumber"/>
        <xs:element ref="title"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="PhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="PhoneNumber" type="xs:integer"/>
  <xs:element name="typeId" type="xs:integer"/>
  <xs:element name="quoteNumber">
    <xs:complexType/>
  </xs:element>
  <xs:element name="dueDate" type="xs:string"/>
  <xs:element name="invoice">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="invoiceId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="taxAmount"/>
        <xs:element ref="total"/>
        <xs:element ref="balance"/>
        <xs:element ref="status"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="invoiceItemList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="invoiceId" type="xs:integer"/>
  <xs:element name="taxAmount" type="xs:decimal"/>
  <xs:element name="balance" type="xs:decimal"/>
  <xs:element name="invoiceItemList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="invoiceItem"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="invoiceItem">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="quantity"/>
        <xs:element ref="cost"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="description"/>
        <xs:element ref="invoiceItemId"/>
        <xs:element ref="price"/>
        <xs:element ref="product"/>
        <xs:element ref="rebate"/>
        <xs:element ref="rebatePercent"/>
        <xs:element ref="subTotal"/>
        <xs:element ref="tax"/>
        <xs:element ref="total"/>
        <xs:element ref="totalCost"/>
        <xs:element ref="uomName"/>
        <xs:element ref="uomQty"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="invoiceItemId" type="xs:integer"/>
  <xs:element name="product">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="externalId"/>
        <xs:element ref="categoryId"/>
        <xs:element ref="competitorProduct"/>
        <xs:element ref="cost"/>
        <xs:element ref="description"/>
        <xs:element ref="enabled"/>
        <xs:element ref="hasSerialNumbers"/>
        <xs:element ref="maxDiscountPercent"/>
        <xs:element ref="mobiworkProductId"/>
        <xs:element ref="modelNumber"/>
        <xs:element ref="name"/>
        <xs:element ref="price"/>
        <xs:element ref="priceIncludesTax"/>
        <xs:element ref="productTypeId"/>
        <xs:element ref="quantity"/>
        <xs:element ref="sku"/>
        <xs:element ref="tax"/>
        <xs:element ref="taxable"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="competitorProduct" type="xs:boolean"/>
  <xs:element name="hasSerialNumbers" type="xs:boolean"/>
  <xs:element name="maxDiscountPercent" type="xs:decimal"/>
  <xs:element name="mobiworkProductId" type="xs:integer"/>
  <xs:element name="modelNumber" type="xs:string"/>
  <xs:element name="priceIncludesTax" type="xs:boolean"/>
  <xs:element name="productTypeId" type="xs:integer"/>
  <xs:element name="sku" type="xs:string"/>
  <xs:element name="rebate" type="xs:decimal"/>
  <xs:element name="rebatePercent" type="xs:decimal"/>
  <xs:element name="subTotal" type="xs:decimal"/>
  <xs:element name="totalCost" type="xs:decimal"/>
  <xs:element name="uomName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="uomQty" type="xs:decimal"/>
  <xs:element name="externalId" type="xs:string"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="address">
    <xs:complexType>
      <xs:sequence>
        <xs:element minOccurs="0" ref="addressId"/>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:choice maxOccurs="unbounded">
          <xs:element ref="name"/>
          <xs:element ref="countryId"/>
          <xs:element ref="latitude"/>
          <xs:element ref="longitude"/>
          <xs:element ref="state"/>
          <xs:element ref="zipCode"/>
        </xs:choice>
        <xs:element minOccurs="0" ref="baseDistance"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="latitude" type="xs:decimal"/>
  <xs:element name="longitude" type="xs:decimal"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode" type="xs:string"/>
  <xs:element name="baseDistance" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="firstName" type="xs:NCName"/>
  <xs:element name="lastName" type="xs:NCName"/>
  <xs:element name="title">
    <xs:complexType/>
  </xs:element>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="altPhoneNumber">
    <xs:complexType/>
  </xs:element>
  <xs:element name="altPhoneExt">
    <xs:complexType/>
  </xs:element>
  <xs:element name="enabled" type="xs:boolean"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="fax">
    <xs:complexType/>
  </xs:element>
  <xs:element name="taxable" type="xs:boolean"/>
  <xs:element name="total" type="xs:decimal"/>
  <xs:element name="quantity" type="xs:decimal"/>
  <xs:element name="cost" type="xs:decimal"/>
  <xs:element name="price" type="xs:decimal"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="tax" type="xs:decimal"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST "https://www.mobiwork.com/api/rest/12014/5.0.141/estimate/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request><status>Status 1</status></request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.141" statusCode="1"> <estimateList> <estimate> <mobiworkEstimateId>123< /mobiworkEstimateId> <externalId>null</externalId> <description>test</description> <status>Status 1</status> <categoryId>4< /categoryId> <category>Category 1</category> <address> <addressId>12345</addressId> <address1>160 Congress Park Dr</address1> < address2>!</address2> <city>Delray Beach</city> <state>Florida</state> <zipCode>33445</zipCode> <countryId>1</countryId> < latitude>26.4582132</latitude> <longitude>-80.0940502</longitude> <name>Primary</name> <baseDistance>123</baseDistance> </address> <quoteNumber>null</quoteNumber> <dueDate>2018/01/04</dueDate> </estimate> </estimateList> </response>