Estimates BETA

Estimates are used to roll-up line item charges and track miscellaneous charges that are not scoped to a single line item.

List estimates

A collection of estimates

GET /estimates

Response

<?xml version="1.0" encoding="UTF-8"?>
<estimates
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateResponse">
  <estimate>
    <!-- an estimate as below -->
  </estimate>
    <!-- an estimate as below -->
  </estimate>
</estimates>

Get single estimate

GET /estimates/{id}

Responses

<?xml version="1.0" encoding="UTF-8"?>
<estimate
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateResponse">
  <id>1234</id>
  <URL>http://www.example.com/estimates/1234</URL>
  <caseURL>http://www.example.com/cases/4321</caseURL>
  <itemsURL>http://www.example.com/estimates/4321/items</caseURL>
  <shopSupplies>5.25</shopSupplies>
  <hazWaste>5.25</hazWaste>
  <freight>5.25</freight>
  <partsTotal>5.25</partsTotal>
  <laborTotal>5.25</laborTotal>
  <coreTotal>5.25</coreTotal>
  <tax>5.25</tax>
  <total>36.75</total>
  <createdAt>2006-05-04T18:13:51.0</createdAt>
  <updatedAt>2006-05-04T18:13:51.0</updatedAt>
</estimate>

Update an estimate

POST /estimates/{id}

Request

Parameters

Name	Condition	Description
shopSupplies	required	total for shop supplies
hazWaste	required	total for shop hazardous waste disposal
freight	required	total for freight
tax	required	total for tax

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<estimate
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateRequest">
  <shopSupplies>5.25</shopSupplies>
  <hazWaste>5.25</hazWaste>
  <freight>5.25</freight>
  <tax>5.25</tax>
</estimate>

Response

Status code: 200 A single estimate response as above

Line Items

Line items represent individual charges on an estimate.

List line items

GET /estimates/{id}/items

Response

Status code: 200

<items
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemResponse"
    xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
    xmlns:eit="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemTypes">
  <item>
    <!-- an item as below -->
  </item>
    <item>
    <!-- an item as below -->
  </item>
</items>

Get single line item

GET /items/{item_id}

Response

Status code: 200

<?xml version="1.0" encoding="UTF-8"?>
<item
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemResponse"
    xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
    xmlns:eit="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemTypes">
  <id>4321</id>
  <URL>http://www.example.com/items/4321</URL>
  <estimateURL>http://www.example.com/estimates/1234</estimateURL>
  <partsURL>http://www.example.com/items/4321/parts</partsURL>
  <code>99-000-1</code>
  <name>Oil Filter - Replace</name>
  <standardOperationNotes>Do it right.</standardOperationNotes>
  <complaint>complaint</complaint>
  <cause>cause</cause>
  <correction>correction</correction>
  <jobCode>123-4</jobCode>
  <priceCode>445589</priceCode>
  <underWarranty>false</underWarranty>
  <billingClassification>billable</billingClassification>
  <approvalStatus>sold</approvalStatus>
  <workStatus>
    <eit:code>start</eit:code>
    <eit:reason>meal</eit:reason>
    <eit:timestamp>2006-05-04T18:13:51.0</eit:timestamp>
    <eit:setByUser>
      <g:id>-1:123</g:id>
    </eit:setByUser>
  </workStatus>
  <assignee>
    <g:id>-1:321</g:id>
  </assignee>
  <labor>
    <eit:total>50.00</eit:total>
    <eit:rate>25.00</eit:rate>
    <eit:hours>2</eit:hours>
  </labor>
  <paint>
    <eit:total>500.00</eit:total>
    <eit:rate>50.00</eit:rate>
    <eit:hours>10</eit:hours>
  </labor>
  <partsTotal>300.00</partsTotal>
  <coreTotal>50.00</coreTotal>
  <total>900.00</total>
  <VMRS>
    <eit:code15>05</eit:code15>
    <eit:code33>555-333-444</eit:code33>
    <eit:code18>22</eit:code18>
    <eit:code79>11</eit:code79>
  </VMRS>
  <createdAt>2006-05-04T18:13:51.0</createdAt>
  <updatedAt>2006-05-04T18:13:51.0</updatedAt>
</item>

Create or update a line item

Create

POST /estimates/{estimate_id}/items

Update

POST /items/{item_id}

Request

Parameters

Name	Condition	Description
code	required	a code that identifies the item
name	required	name or description
standardOperationNotes	optional	notes viewable by the service provider
complaint	optional	description of complaint
cause	optional	description of cause
correction	optional	description of correction
jobCode	optional	job segment code
priceCode	optional	labor price code
workStatus	optional	status of work
workStatus:code	required	`Start`, `Stop`, `Complete`
workStatus:reason	optional	reason for last status change
workStatus:timestamp	optional	timestamp of last status change
workStatus:setByUser	optional	user responsible for last status change
assignee	optional	current assigned user
approvalStatus	optional	`sold`, `not sold`, `deferred`
underWarranty	optional	flag for warranty item
billingClassification	optional	category for item: `billable`, `policy`, `warranty`
labor	optional	labor charges
labor:total	optional	labor total
labor:rate	optional	labor rate
labor:hours	optional	labor time in hours
labor:skillLevel	optional	skill level used to determine rate
paint	optional	paint charges
paint:total	optional	paint total
paint:rate	optional	paint rate
paint:hours	optional	paint time in hours
paint:skillLevel	optional	skill level used to determine rate
fixedPriceTotal	optional	fixed price override for an item
vmrs	optional	vmrs coding information
vmrs:code15	required	vmrs code 15
vmrs:code14	required	vmrs code 14
vmrs:code18	required	vmrs code 18
vmrs:code79	required	vmrs code 79
vmrs:code33	required	vmrs code 33

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<item
    xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemRequest"
    xmlns:g="http://www.decisiv.net/platform_api/0.0.7/Case/GroupedUser"
    xmlns:eit="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemTypes">
  <code>99-000-1</code>
  <name>Oil Filter - Replace</name>
  <standardOperationNotes>Do it right.</standardOperationNotes>
  <complaint>complaint</complaint>
  <cause>cause</cause>
  <correction>correction</correction>
  <underWarranty>false</underWarranty>
  <billingClassification>billable</billingClassification>
  <approvalStatus>sold</approvalStatus>
  <workStatus>
    <eit:code>start</eit:code>
    <eit:reason>meal</eit:reason>
    <eit:timestamp>2006-05-04T18:13:51.0</eit:timestamp>
    <eit:setByUser>
      <g:id>-1:123</g:id>
    </eit:setByUser>
  </workStatus>
  <assignee>
    <g:id>-1:321</g:id>
  </assignee>
  <labor>
    <eit:total>50.00</eit:total>
    <eit:rate>25.00</eit:total>
    <eit:hours>2</eit:total>
  </labor>
  <fixedPriceTotal>400.00</fixedPriceTotal>
  <VMRS>
    <eit:code15>05</eit:code15>
    <eit:code33>555-333-444</eit:code33>
    <eit:code18>22</eit:code18>
    <eit:code79>11</eit:code79>
  </VMRS>
</item>

Response

Status codes: - 201 create - 200 update

A single line item as above

Delete a line item

DELETE /items/{item_id}

Response

HTTP codes 200, 202 or 204 indicate success

List parts for an item

Request

GET /items/{item_id}/parts

Response

Status code: 200

<parts>
  <part>
    <!-- a part as below -->
  </part>
</parts>

Get a single part

Request

GET /items/{item_id}/parts/{part_id}

Response

Status code: 200

<part>
  <id>5678</id>
  <URL>http://www.example.com/items/4321/parts/5678</URL>
  <itemURL>http://www.example.com/items/4321</itemURL>
  <name>Filter</name>
  <partNumber>8675309</partNumber>
  <quantity>2</quantity>
  <quantityShipped>2</quantityShipped>
  <quantityBackordered>0</quantityBackordered>
  <unitPrice>0.25</unitPrice>
  <coreQuantity>2</coreQuantity>
  <unitCorePrice>0.05</unitCorePrice>
  <totalPrice>0.05</totalPrice>
  <createdAt>2006-05-04T18:13:51.0</createdAt>
  <updatedAt>2006-05-04T18:13:51.0</updatedAt>
</part>

Create or update a part

Create

POST /items/{item_id}/parts

Update

PUT /items/{item_id}/parts/{part_id}

Request

Parameters

Name	Condition	Description
name	required	part name or description
partNumber	required	part number
quantity	required	quantity of part
quantityShipped	optional	quantity of parts shipped
quantityBackordered	optional	quantity of parts backordered
unitPrice	required	part price per unit in USD
coreQuantity	required	quantity of cores
unitCorePrice	required	core price per unit in USD

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<part
  xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/EstimateItemPartRequest">
  <name>Filter</name>
  <partNumber>8675309</partNumber>
  <quantity>2</quantity>
  <quantityShipped>2</quantityShipped>
  <quantityBackordered>0</quantityBackordered>
  <unitPrice>0.25</unitPrice>
  <coreQuantity>2</coreQuantity>
  <unitCorePrice>0.05</unitCorePrice>
</part>

Response

Status code: 201 for create, 200 for update

A single part response as above

Delete a part

DELETE /items/{item_id}/parts/{part_id}

Response

HTTP codes 200, 202 or 204 indicate success