Estimates

An estimate provides a quote to a Customer. Like invoices, each estimate has a collection of line items that detail the products or services. Estimates, unlike invoices, do not have a balance owed until converted to an invoice.

Estimate Object

Attributes

{
    "approved": null,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "deposit": 0,
    "deposit_paid": false,
    "discounts": [],
    "draft": false,
    "expiration_date": null,
    "id": 2048,
    "invoice": null,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": null,
    "notes": null,
    "number": "EST-0016",
    "object": "estimate",
    "payment_terms": "NET 14",
    "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "not_sent",
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
}

Create an estimate

curl "https://api.invoiced.com/estimates" \
  -u {API_KEY}: \
  -d customer=15444 \
  -d payment_terms="NET 14" \
  -d items[0][name]="Copy paper, Case" \
  -d items[0][quantity]=1 \
  -d items[0][unit_cost]=45 \
  -d items[1][catalog_item]="delivery" \
  -d items[1][quantity]=1 \
  -d taxes[0][amount]=3.85

invoiced.Estimate.create(
  :customer => 15444,
  :payment_terms => "NET 14",
  :items => [
    {
      :name => "Copy paper, Case",
      :quantity => 1,
      :unit_cost => 45
    },
    {
      :catalog_item => "delivery",
      :quantity => 1
    }
  ],
  :taxes => [
    {
      :amount => 3.85
    }
  ]
)

<?php

$estimate = $invoiced->Estimate->create([
  'customer' => 15444,
  'payment_terms' => "NET 14",
  'items' => [
    [
      'name' => "Copy paper, Case",
      'quantity' => 1,
      'unit_cost' => 45
    ],
    [
      'catalog_item' => "delivery",
      'quantity' => 1
    ]
  ],
  'taxes' => [
    [
      'amount' => 3.85
    ]
  ]
]);

client.Estimate.create(
  customer=15444,
  payment_terms="NET 14",
  items=[
    {
      'name': "Copy paper, Case",
      'quantity': 1,
      'unit_cost': 45
    },
    {
      'catalog_item': "delivery",
      'quantity': 1
    }
  ],
  taxes=[
    {
      'amount': 3.85
    }
  ]
)

Estimate estimate = invoiced.newEstimate();
estimate.customer = 15444L;
estimate.paymentTerms = "NET 14";
LineItem[] items = new LineItem[2];
items[0] = new LineItem();
items[0].name = "Copy paper, Case";
items[0].quantity = 1D;
items[0].unitCost = 45D;
items[1] = new LineItem();
items[1].item = "delivery";
items[1].quantity = 1D;
Tax[] taxes = new Tax[1];
taxes[0] = new Tax();
taxes[0].amount = 3.85D;
estimate.items = items;
estimate.taxes = taxes;
estimate.create();

var estimate = invoiced.NewEstimate();
estimate.Customer = 15444;
estimate.PaymentTerms = "NET 14";
var items = new LineItem[2];
items[0] = new LineItem();
items[0].Name = "Copy paper, Case";
items[0].Quantity = 1;
items[0].UnitCost = 45;
items[1] = new LineItem();
items[1].Item = "delivery";
items[1].Quantity = 1;
var taxes = new Tax[1];
taxes[0] = new Tax();
taxes[0].Amount = 3.85;
estimate.Items = items;
estimate.Taxes = taxes;
estimate.Create();

estimate, err := client.Estimate.Create(&invoiced.EstimateRequest{
  Customer: invoiced.Int64(15444),
  PaymentTerms: invoiced.String("NET 14"),
  Items: []*invoiced.LineItemRequest{
    {
      Name: invoiced.String("Copy paper, Case"),
      Quantity: invoiced.Float64(1),
      UnitCost: invoiced.Float64(45),
    },
    {
      Item: invoiced.String("delivery"),
      Quantity: invoiced.Float64(1),
    },
  },
  Taxes: []*invoiced.TaxRequest{
    {
      Amount: invoiced.Float64(3.85),
    },
  },
})

The above command returns JSON structured like this:

{
    "approved": null,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "deposit": 0,
    "deposit_paid": false,
    "discounts": [],
    "draft": false,
    "expiration_date": null,
    "id": 2048,
    "invoice": null,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": null,
    "notes": null,
    "number": "EST-0016",
    "object": "estimate",
    "payment_terms": "NET 14",
    "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "not_sent",
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
}

Create a new estimate with this endpoint.

HTTP Request

POST /estimates

Attributes

Retrieve an estimate

curl "https://api.invoiced.com/estimates/:id" \
  -u {API_KEY}:

estimate = invoiced.Estimate.retrieve("{ESTIMATE_ID}")

<?php

$estimate = $invoiced->Estimate->retrieve("{ESTIMATE_ID}");

estimate = client.Estimate.retrieve("{ESTIMATE_ID}")

Estimate estimate = invoiced.newEstimate().retrieve({ESTIMATE_ID});

var estimate = invoiced.NewEstimate().Retrieve({ESTIMATE_ID});

estimate, err := client.Estimate.Retrieve({ESTIMATE_ID})

The above command returns JSON structured like this:

{
    "approved": null,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "deposit": 0,
    "deposit_paid": false,
    "discounts": [],
    "draft": false,
    "expiration_date": null,
    "id": 2048,
    "invoice": null,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": null,
    "notes": null,
    "number": "EST-0016",
    "object": "estimate",
    "payment_terms": "NET 14",
    "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "not_sent",
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
}

This endpoint retrieves a specific estimate.

HTTP Request

GET /estimates/:id

If you set the Accept header to application/pdf then the estimate PDF will be returned.

Query Parameters

Update an estimate

curl "https://api.invoiced.com/estimates/:id" \
  -u {API_KEY}: \
  -X PATCH \
  -d sent=1

estimate.name = "July Paper Delivery"
estimate.notes = "The order was delivered on Jul 20, 2015"
estimate.sent = true
estimate.save

<?php

$estimate->name = "July Paper Delivery";
$estimate->notes = "The order was delivered on Jul 20, 2015";
$estimate->sent = true;
$estimate->save();

estimate.name = "July Paper Delivery"
estimate.notes = "The order was delivered on Jul 20, 2015"
estimate.sent = True
estimate.save()

estimate.name = "July Paper Delivery";
estimate.notes = "The order was delivered on Jul 20, 2015";
estimate.sent = true;
estimate.save();

estimate.Name = "July Paper Delivery";
estimate.Notes = "The order was delivered on Jul 20, 2015";
estimate.Sent = true;
estimate.Save();

estimate, err := client.Estimate.Update({ESTIMATE_ID}, &invoiced.EstimateRequest{
  Name: invoiced.String("July Paper Delivery"),
  Notes: invoiced.String("The order was delivered on Jul 20, 2015"),
  Sent: invoiced.Bool(true),
})

The above command returns JSON structured like this:

{
    "approved": false,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "deposit": 0,
    "deposit_paid": false,
    "discounts": [],
    "draft": false,
    "expiration_date": null,
    "id": 2048,
    "invoice": null,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": "July Paper Delivery",
    "notes": "The order was delivered on Jul 20, 2015",
    "number": "EST-0016",
    "object": "estimate",
    "payment_terms": "NET 14",
    "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "sent",
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
}

Use this endpoint to update an estimate.

HTTP Request

PATCH /estimates/:id

Attributes

Send an estimate

curl "https://api.invoiced.com/estimates/:id/emails" \
  -u {API_KEY}: \
  -X POST

emails = estimate.send

<?php

$emails = $estimate->send();

emails = estimate.send()

EmailRequest emailRequest = new EmailRequest();
EmailRecipient[] emailRecipients = new EmailRecipient[1];
emailRecipients[0] = new EmailRecipient();
emailRecipients[0].name = "Client";
emailRecipients[0].email = "client@example.com";

emailRequest.to = emailRecipients;
emailRequest.subject = "New Estimate from Dunder Mifflin, Inc.: EST-0016";
emailRequest.message = "Dear Client, a new estimate for $51.15 has been created on your account. Thank you!";

Email[] emails = estimate.send(emailRequest);

var emailRequest = new EmailRequest();
var emailRecipients = new EmailRecipient[1];
emailRecipients[0] = new EmailRecipient();
emailRecipients[0].Name = "Client";
emailRecipients[0].Email = "client@example.com";

emailRequest.To = emailRecipients;
emailRequest.Subject = "New Estimate from Dunder Mifflin, Inc.: EST-0016";
emailRequest.Message = "Dear Client, a new estimate for $51.15 has been created on your account. Thank you!";

var emails = estimate.SendEmail(emailRequest);

err := client.Estimate.SendEmail({ESTIMATE_ID}, &invoiced.SendEmailRequest{
  To: []*invoiced.EmailRecipient{
    Name: invoiced.String("Client"),
    Email: "client@example.com",
  },
  Subject: invoiced.String("New Estimate from Dunder Mifflin, Inc.: EST-0016"),
  Message: invoiced.String("Dear Client, a new estimate for $51.15 has been created on your account. Thank you!"),
})

The above command returns JSON structured like this:

[
  {
     "created_at": 1436890047,
     "email": "client@example.com",
     "id": "f45382c6fbc44d44aa7f9a55eb2ce731",
     "message": "Dear Client, a new estimate for $51.15 has been created on your account. Thank you!",
     "object": "email",
     "opens": 0,
     "opens_detail": [],
     "reject_reason": null,
     "state": "sent",
     "subject": "New Estimate from Dunder Mifflin, Inc.: EST-0016",
     "template": "estimate_email",
     "updated_at": 1436890047
 }
]

This endpoint sends an estimate to your customer.

HTTP Request

POST /estimates/:id/emails

Request Parameters

Generate an invoice

curl "https://api.invoiced.com/estimates/:estimate_id/invoice" \
  -u {API_KEY}: \
  -X POST

invoice = estimate.generate_invoice

<?php

$invoice = $estimate->invoice();

invoice = estimate.invoice()

Invoice invoice = estimate.invoice();

var invoice = estimate.Invoice();

invoice, err := client.Estimate.GenerateInvoice({ESTIMATE_ID})

The above command returns JSON structured like this:

{
    "attempt_count": 0,
    "autopay": false,
    "balance": 51.15,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "discounts": [],
    "draft": false,
    "due_date": 1417500000,
    "id": 46225,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": null,
    "next_payment_attempt": null,
    "notes": null,
    "number": "INV-0016",
    "object": "invoice",
    "paid": false,
    "payment_plan": null,
    "payment_terms": "NET 14",
    "payment_url": "https://dundermifflin.invoiced.com/invoices/IZmXbVOPyvfD3GPBmyd6FwXY/payment",
    "pdf_url": "https://dundermifflin.invoiced.com/invoices/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "not_sent",
    "subscription": null,
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/invoices/IZmXbVOPyvfD3GPBmyd6FwXY"
}

This endpoint generates an invoice from an estimate.

HTTP Request

POST /estimates/:estimate_id/invoice

List estimate attachments

curl "https://api.invoiced.com/estimates/:id/attachments" \
  -u {API_KEY}:

attachments, metadata = estimate.attachments

<?php

list($attachments, $metadata) = $estimate->attachments();

attachments, metadata = estimate.attachments()

Attachment[] attachments = estimate.listAttachments();

var attachments = estimate.ListAttachments();

attachments, err := client.Estimate.ListAttachments({ESTIMATE_ID})

The above command returns JSON structured like this:

[
  {
     "created_at": 1464625855,
     "file": {
         "created_at": 1464625854,
         "id": 13,
         "name": "logo-invoice.png",
         "object": "file",
         "size": 6936,
         "type": "image/png",
         "updated_at": 1464625854,
         "url": "https://invoiced.com/img/logo-invoice.png"
     },
     "id": 13,
     "object": "attachment",
     "updated_at": 1464625855
 }
]

This endpoint retrieves a list of files attached to a specific estimate.

HTTP Request

GET /estimates/:id/attachments

Void an estimate

curl "https://api.invoiced.com/estimates/:id/void" \
  -u {API_KEY}: \

estimate.void

<?php

$estimate->void();

estimate.void()

estimate.voidEstimate();

estimate.Void();

estimate, err := client.Estimate.Void({ESTIMATE_ID})

The above command returns JSON structured like this:

{
    "approved": false,
    "closed": false,
    "created_at": 1415229884,
    "currency": "usd",
    "customer": 15444,
    "date": 1416290400,
    "deposit": 0,
    "deposit_paid": false,
    "discounts": [],
    "draft": false,
    "expiration_date": null,
    "id": 2048,
    "invoice": null,
    "items": [
        {
            "amount": 45,
            "catalog_item": null,
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 7,
            "metadata": [],
            "name": "Copy Paper, Case",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "product",
            "unit_cost": 45
        },
        {
            "amount": 10,
            "catalog_item": "delivery",
            "description": null,
            "discountable": true,
            "discounts": [],
            "id": 8,
            "metadata": [],
            "name": "Delivery",
            "object": "line_item",
            "quantity": 1,
            "taxable": true,
            "taxes": [],
            "type": "service",
            "unit_cost": 10
        }
    ],
    "metadata": [],
    "name": "July Paper Delivery",
    "notes": "The order was delivered on Jul 20, 2015",
    "number": "EST-0016",
    "object": "estimate",
    "payment_terms": "NET 14",
    "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
    "purchase_order": null,
    "ship_to": null,
    "status": "voided",
    "subtotal": 55,
    "taxes": [
        {
            "amount": 3.85,
            "id": 20554,
            "object": "tax",
            "tax_rate": null
        }
    ],
    "total": 51.15,
    "updated_at": 1415229884,
    "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
}

Use this endpoint to void an estimate.

HTTP Request

POST /estimates/:id/void

Delete an estimate

curl "https://api.invoiced.com/estimates/:id" \
  -u {API_KEY}: \
  -X DELETE

estimate.delete

<?php

$estimate->delete();

estimate.delete()

estimate.delete();

estimate.Delete();

err := client.Estimate.Delete({ESTIMATE_ID})

The above command returns 204 No Content

This endpoint deletes a specific estimate.

HTTP Request

DELETE /estimates/:id

List all estimates

curl "https://api.invoiced.com/estimates" \
  -u {API_KEY}:

estimates, metadata = invoiced.Estimate.list(:per_page => 3)

<?php

list($estimates, $metadata) = $invoiced->Estimate->all(['per_page' => 3]);

estimates, metadata = client.Estimate.list(per_page=3)

EntityList<Estimate> estimates = conn.newEstimate().listAll();

var estimates = invoiced.NewEstimate().ListAll();

estimates, err := client.Estimate.ListAll(nil, nil)

The above command returns JSON structured like this:

[
  {
     "approved": null,
     "closed": false,
     "created_at": 1415229884,
     "currency": "usd",
     "customer": 15444,
     "date": 1416290400,
     "deposit": 0,
     "deposit_paid": false,
     "discounts": [],
     "draft": false,
     "expiration_date": null,
     "id": 2048,
     "invoice": null,
     "items": [
         {
             "amount": 45,
             "catalog_item": null,
             "description": null,
             "discountable": true,
             "discounts": [],
             "id": 7,
             "metadata": [],
             "name": "Copy Paper, Case",
             "object": "line_item",
             "quantity": 1,
             "taxable": true,
             "taxes": [],
             "type": "product",
             "unit_cost": 45
         },
         {
             "amount": 10,
             "catalog_item": "delivery",
             "description": null,
             "discountable": true,
             "discounts": [],
             "id": 8,
             "metadata": [],
             "name": "Delivery",
             "object": "line_item",
             "quantity": 1,
             "taxable": true,
             "taxes": [],
             "type": "service",
             "unit_cost": 10
         }
     ],
     "metadata": [],
     "name": null,
     "notes": null,
     "number": "EST-0016",
     "object": "estimate",
     "payment_terms": "NET 14",
     "pdf_url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY/pdf",
     "purchase_order": null,
     "ship_to": null,
     "status": "not_sent",
     "subtotal": 55,
     "taxes": [
         {
             "amount": 3.85,
             "id": 20554,
             "object": "tax",
             "tax_rate": null
         }
     ],
     "total": 51.15,
     "updated_at": 1415229884,
     "url": "https://dundermifflin.invoiced.com/estimates/IZmXbVOPyvfD3GPBmyd6FwXY"
 }
]

This endpoint retrieves all estimates.

HTTP Request

GET /estimates

Query Parameters