Documentation
Difficulty level:
This section only applies if the module Invoice is active.
API - Invoice - GET invoice/{id}
GET invoice/{id}
Used for
getting the information of a specific invoice.
Authentication
Requires authentication.
Parameters
| Parameter | Description | Required | Example |
|---|---|---|---|
| id | ID of the invoice | Yes | 13 |
Expansion
| Type | Description |
|---|---|
| lines | the detail lines for invoice |
Response codes
- 200 OK
Example
Getting the information of invoice 13.
GET api/rest/invoice/13?expand=lines
Response:
{
"invoice_id": "1363",
"status": "draft",
"date": "Sat Jul 09, 2011",
"draftdate": "Sat Jul 09, 2011",
"finaldate": "Sat Jul 09, 2011",
"booking_id": null,
"customer": "",
"price": "50",
"currency": "EUR",
"lines": [
{
"detail": "Header",
"desc": "Squashen",
"discount": "",
"discount_total": "€ 0,00",
"fromdate": "Fri Sep 23 2011",
"fromtime": "13:30:00",
"tilldate": "Fri Sep 23 2011",
"tilltime": "16:50:00",
"number": "1",
"subtotal": "€ 48,00",
"currency": "EUR",
"price": "€ 48,00",
"vat": "€ 0,00",
"vat_excl": "€ 48,00",
"vat_desc": "",
"participants": "0",
"fee_desc": "",
"fee_amount": "€ 0,00",
"fee_sub": "€ 0,00",
"fee_vat": "€ 0,00",
"fee_vat_exclusive": "€ 0,00",
"nbr_nights": "0",
"nbr_days": 1,
"nbr_months": "0"
},
{
"detail": "Header",
"desc": "Squashen",
"discount": "",
"discount_total": "€ 0,00",
"fromdate": "Fri Sep 23 2011",
"fromtime": "13:30:00",
"tilldate": "Fri Sep 23 2011",
"tilltime": "13:55:00",
"number": "1",
"subtotal": "€ 6,00",
"currency": "EUR",
"price": "€ 6,00",
"vat": "€ 0,00",
"vat_excl": "€ 6,00",
"vat_desc": "",
"participants": "0",
"fee_desc": "",
"fee_amount": "€ 0,00",
"fee_sub": "€ 0,00",
"fee_vat": "€ 0,00",
"fee_vat_exclusive": "€ 0,00",
"nbr_nights": "0",
"nbr_days": 1,
"nbr_months": "0"
}
]
}
