Find here the list of actions to apply on the objects, and the data reference for this object.

What is a proposal ?

An proposal (we call it a proposal sheet) represents a quotation your make for your prospects and clients.

Getting the proposals list

GET /proposal_sheets.xml

Returns all proposals, page by page
Add a page parameter to navigate

Getting a single proposal

GET /proposal_sheets/#{id}.xml

Returns a single proposal, identified by its id

Creating a new proposal

POST /proposal_sheets.xml

Creates a new proposal, and returns the proposal data

Updating an existing proposal

PUT /proposal_sheets/#{id}.xml

Updates some fields of an existing proposal

Deleting an existing proposal

DELETE /proposal_sheets/#{id}.xml

Deletes the proposal identified by its id

Object data

<proposal_sheet>
 <id>id of proposal</id>
 <sheet_type>proposal or delivery note (see below)</sheet_type>
 <progress_id>id of proposal progress (see below)</progress_id>
 <contact_id>attached to contact id (0 if none)</contact_id>
 <firm_id>attached to firm id (0 if none)</firm_id>
 <bank_account_id>id of bank account to display on proposal</bank_account_id>
 <reference>reference of proposal (automatic)</reference>
 <title>title</title>
 <subtitle>subtitle</subtitle>
 <billing_date>date of proposal</billing_date>
 <reduction_percent>percentage of reduction</reduction_percent>
 <vat_value_id>vat code id (see below)</vat_value_id>
 <vat_cost>vat value</vat_cost>
 <shipping_cost>cost of shipping</shipping_cost>
 <vat_exl_total>total of proposal without vat</vat_exl_total>
 <vat_inc_total>total of proposal with vat</vat_inc_total>
 <vat_exc_total_with_shipping>total of proposal without vat with shipping</vat_exc_total_with_shipping>
 <billing_add_street_address>billing street address</billing_add_street_address>
 <billing_add_name>billing address complement</billing_add_name>
 <billing_add_zip_code>billing address zip</billing_add_zip_code>
 <billing_add_city>billing address city</billing_add_city>
 <billing_add_country>France</billing_add_country>
 <shipping_add_street_address>shipping street address</shipping_add_street_address>
 <shipping_add_name>shipping address complement</shipping_add_name>
 <shipping_add_zip_code>shipping address zip</shipping_add_zip_code>
 <shipping_add_city>shipping address city</shipping_add_city>
 <shipping_add_country>France</shipping_add_country>
 <comment_for_party>comment to display for the party</comment_for_party>
 <party_agreement_text>Text to display in signature box</party_agreement_text>
 <lead_id>id of related lead</lead_id>
 <project_id>id of related project</project_id>
 <validity_show>show validity date (0 or 1)</validity_show>
 <validity_date>validity date of proposal</validity_date>
 <proposal_lines>
  <proposal_line>
   <description>description of line</description>
   <description_more>more description of line</description_more>
   <unit_price>price per unit</unit_price>
   <quantity>quantity</quantity>
   <total_price>total line price</total_price>
   <vat_value_id>id of vat (see below)</vat_value_id>
   <vat_value>value of vat</vat_value>
   <ordering>ordering index</ordering>
  </proposal_line>
 </proposal_lines>
</proposal_sheet>

Possible values of vat_id

• 222 for 2.1%

• 223 for 5.5%

• 224 for 19.6%

• 225 for no VAT

• 529 for 19%

• 543 for 8.5%

• 544 for 21%

• 545 for 7.6%

• 546 for 16%

• 551 for 15%

• 552 for 10%

• 553 for 3%

• 567 for 18%

• 569 for 8.5% NPR

• 607 for 20%

• 615 for 6%

Possible values of proposal progress

• 555 for draft

• 556 for sent to prospect

• 557 for accepted by prospect

• 558 for refused by prospect

• 559 for sleeping

Possible values of proposal sheet type

• proposal for a proposal you send to your customers (you propose)

• delivery_note for a delivery note you send to your customers (you deliver)

• purchase_order for a purchase order you send to your vendors (you order)