Receipt
Field guide
The following fields are available in a receipt object
| Name | Type | Example | Notes |
|---|---|---|---|
| id | int | 43 | Receipt id |
| number | string | 4633 | Your receipt 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 receipt | Title of the receipt |
| date | date | 2012-03-25 | Date of receipt |
| introduction | string | text | Introduction text printed above positions |
| conditions | string | text | Text printed below positions |
| language | string | de | Two-letter language code |
| 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":3,
"number":10000,
"client_id":16,
"client_name":"John Doe",
"client_address_id":11,
"client_contact_id":0,
"currency":"CHF",
"title":"Lieferschein Nr. {LIEFERSCHEINNR} \/ Kunden Nr. {KUNDENNR}",
"date":"2013-02-25",
"conditions":"",
"introduction":"",
"language":"de",
"vat_included":0,
"totalamount":0,
"status":7,
"pages":1,
"positions":[
{
"type":1,
"number":null,
"name":"Position X",
"description":"Repairing car",
"cost":0,
"unit":1,
"amount":1,
"vat":8,
"discount":null
},
{
"type":2,
"number":null,
"name":"Position Y",
"description":"Cleaning house",
"cost":0,
"unit":7,
"amount":1,
"vat":8,
"discount":null
}
]
}
}
Status
| Status | Meaning of status |
|---|---|
| 1 | Sent / Open |
| 7 | Draft |
| 10 | Billed |
