Offer
Field guide
The following fields are available in a offer object
Name | Type | Example | Notes |
---|---|---|---|
id | int | 43 | Offer id |
number | string | 4633 | Your offer number |
client_id | int | 1 | Client's id |
client_name | string | Jane Doe | Name of client |
client_address_id | int | 1 | Client's address id |
client_contact_id | int | 0 | Client's contact id |
currency | string | EUR | Three-letter currency code |
title | string | My new offer | Title of the offer |
period | string | Period of service | |
date | date | 2012-03-25 | Date of offer |
due | date | 2012-04-22 | Latest payment date |
discount | float | 5 | Discount amount |
discount_type | int | 1 | See Discount Types |
introduction | string | text | Introduction text printed above positions |
conditions | string | text | Text printed below positions |
language | string | de | Two-letter language code |
acceptonline | int | 0 | Enabling feature to accept online offers |
vat_included | int | 1 | If VAT is included in positions' prices |
totalamount | float | 140.15 | Total sum of all positions |
status | int | 7 | See Status Types |
pages | int | 2 | Number of pages |
positions | collection | Collection of Position Objects |
Example content of data variable:
{ "error":false, "item":{ "id":4, "number":10000, "client_id":16, "client_name":"John Doe", "client_address_id":11, "client_contact_id":0, "currency":"CHF", "title":"Offerte Nr. {OFFERTENNR} \/ Kunden Nr. {KUNDENNR}", "period":"", "date":"2013-02-25", "due":"2013-03-07", "discount":0, "discount_type":0, "conditions":"", "introduction":"", "language":"de", "acceptonline":0, "vat_included":0, "totalamount":0, "status":7, "pages":1, "positions":[ { "type":1, "number":null, "name":"Service Y", "description":"Cleaning house", "cost":0, "unit":1, "amount":1, "vat":8, "discount":null }, { "type":2, "number":null, "name":"Product X", "description":"Repairing car", "cost":0, "unit":7, "amount":1, "vat":8, "discount":null } ] } }
Status
Status | Meaning of status |
---|---|
1 | Sent / Open |
7 | Draft |
8 | Declined |
9 | Accepted |
10 | Billed |