Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venue_groups
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: get_invoice
Retrieves a specific invoice
Required Parameters | Possible Values | Description |
invoice | Invoice Reference | Invoice Reference |
Example Response ↓ Show |
{ "client":"MIDAS (MIDAS2)", "date":"5/11/2012 @ 10:00", "items":[ { "description":"Room 1 (6/11/2012 @ 19:30 - 21:30)", "qty":"2.00", "rate":"23.50", "tax_rate":"20.00", "tax_amount":"4.70" }, { "description":"Room 2 (13/11/2012 @ 19:30 - 21:30)", "qty":"2.00", "rate":"23.50", "tax_rate":"20.00", "tax_amount":"4.70" } ], "total":"188.00", "paid":"0.00", "history":[ { "action":"Created", "date":"5/11/2012 @ 08:45", "user":"MIDAS Administrator" }, { "action":"Modified", "date":"5/11/2012 @ 09:42", "user":"MIDAS Administrator" }, { "action":"Emailed", "date":"5/11/2012 @ 10:00", "user":"MIDAS Administrator" } ] } |
Variables Returned | Description |
client | Client |
date | Invoice Date (or "Invoice Not Sent if invoice hasn't been emailed/printed) |
items | Invoice items |
description | The item's description |
qty | The item's quantity |
rate | The item's rate (charge) |
tax_rate | The percentage tax applied to the item |
tax_amount | The amount of tax applied to the item |
total | Invoice total (ex tax) |
paid | Amount paid |
history | Invoice history |
action | The action performed. This will be one of the following: "Created", "Modified", "Printed", "Emailed", "Payment Received", "Payment Overdue", "Paid In Full" |
date | The date/time the action occurred |
user | The user who performed the action |