Cashboard API

« Back to Overview

Estimates

Operations on this resource are restricted to admins only.

List
GET /estimates

Parameters

  • client_id / client_type
    client_id is an id of either a Client Company or Client Contact.
    client_type must be set to either 'Company' (Client Company) or 'Person' (Client Contact) if client_id is set.
  • is_archived
    true returns only ARCHIVED projects
    false returns only OPEN projects
  • updated_since
    Returns all projects last modified after the given date/time.
    Expects a CGI encoded datetime in the form of YYYY-MM-DD HH:MM:SS

New
GET /estimates/new

Returns a data template that you can fill in to use the CREATE action.

Create
POST /estimates

Creates a new estimate. Use the template provided by the NEW action.

Actions

Show
GET [estimate link 'self']

Returns a single estimate.

Can return estimate in a variety of formats,
including HTML and PDF as you'd see in the Cashboard web UI.

Supported Content Types

  • application/xml
  • application/pdf
  • text/html

Update
PUT [estimate link 'self']

Updates a estimate.

Delete
DELETE [estimate link 'self']

Deletes an estimate and all comments associated with it.

Toggle Status
PUT [estimate link 'toggle_status']

Closes an open estimate, or opens a closed estimate.

Line Items

List All Items
GET [estimate link 'line_items']

Returns all line items associated with this estimate.
This includes all tasks, products, and custom items.

List Task Items
GET [estimate link 'line_item_tasks']

Returns all line items marked as a task for this estimate.

List Product Items
GET [estimate link 'line_item_products']

Returns all line items marked as a product for this estimate.

List Custom Items
GET [estimate link 'line_item_customs']

Returns all line items marked as a custom item for this estimate.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<estimate>
  <address></address>
  <assigned_id></assigned_id>
  <agreement_text></agreement_text>
  <client_id></client_id>
  <client_type></client_type>
  <comments_count read_only="true">0</comments_count>
  <created_on></created_on>
  <discount_percentage rel="financial"></discount_percentage>
  <document_template_id></document_template_id>
  <has_been_sent>false</has_been_sent>
  <intro_text></intro_text>
  <is_archived>false</is_archived>
  <name></name>
  <po_number></po_number>
  <requires_agreement>false</requires_agreement>
  <sales_tax rel="financial"></sales_tax>
  <sales_tax_2 rel="financial"></sales_tax_2>
  <sales_tax_2_cumulative rel="financial">false</sales_tax_2_cumulative>
  <discount_best rel="financial" read_only="true">-0.0</discount_best>
  <discount_worst rel="financial" read_only="true">-0.0</discount_worst>
  <item_actual_best rel="financial" read_only="true">0.0</item_actual_best>
  <item_actual_worst rel="financial" read_only="true">0.0</item_actual_worst>
  <item_cost_best rel="financial" read_only="true">0.0</item_cost_best>
  <item_cost_worst rel="financial" read_only="true">0.0</item_cost_worst>
  <item_profit_best rel="financial" read_only="true">0.0</item_profit_best>
  <item_profit_worst rel="financial" read_only="true">0.0</item_profit_worst>
  <item_taxable_best rel="financial" read_only="true">0.0</item_taxable_best>
  <item_taxable_worst rel="financial" read_only="true">0.0</item_taxable_worst>
  <price_best rel="financial" read_only="true">0.0</price_best>
  <price_worst rel="financial" read_only="true">0.0</price_worst>
  <tax_cost_best rel="financial" read_only="true">0.0</tax_cost_best>
  <tax_cost_worst rel="financial" read_only="true">0.0</tax_cost_worst>
  <tax_cost_2_best rel="financial" read_only="true">0.0</tax_cost_2_best>
  <tax_cost_2_worst rel="financial" read_only="true">0.0</tax_cost_2_worst>
  <time_best_in_minutes read_only="true">0</time_best_in_minutes>
  <time_worst_in_minutes read_only="true">0</time_worst_in_minutes>
  <updated_at read_only="true"></updated_at>
</estimate>

Property Reference

  • client_id / client_type
    client_id is an id of either a Client Company or Client Contact.
    client_type must be set to either 'Company' (Client Company) or 'Person' (Client Contact) if client_id is set.
    • assigned_id The display "number" of an estimate.
    agreement_text Used to specify terms of agreement.
    created_on Creation date of this estimate.
    discount_percentage Floating point value
    document_template_id ID of the document_template used to display this estimate.
    has_been_sent Will be set to true if it has been emailed via the system.
    May also be set manually if customer post-mails their estimates.
    intro_text Introduction / header text.
    is_active Boolean that reports if estimate is active or closed.
    name Pretty display name of the estimate.
    requires_agreement Determines if a customer must indicate their agreement via the Cashboard Client UI.
    sales_tax Floating point value. Specified as a percentage.
    sales_tax_2 Floating point value. Specified as a percentage.
    sales_tax_cumulative Boolean. Determines if sales_tax_2 is a compound tax, including sales_tax
    updated_at Datetime string when this was last modified.

    BEST / WORST

    A variety of fields are accessible on each estimate that give you a summary of all line item data.

    These properties give you access to the best (low) and worst (high) case scenarios for your estimate.

    discount Dollar amount of discount applied.
    item_actual Dollar amount of all line_items, including markup_percentage.
    item_cost Dollar amount of all line_items, before markup_percentage.
    item_profit Dollar amount made via markup_percentage on all line items.
    item_taxable Dollar amount of items that are marked taxable.
    price Total dollar amount of the entire estimate.
    tax_cost Total dollar amount for items taxed with sales_tax
    tax_cost_2 Total dollar amount for items taxed with sales_tax_2
    time Amount of estimated time in minutes.