getInvoices JSON

Instructions

Post JSON data here to get information about booking invoices in an account.

See here for information about using the JSON API.

Request Parameters

Parameter	Usage	Description	Values
apiKey	required	Account apiKey	string
propKey	required	Property apiKey	string
bookId	optional	Booking number, when specified, only invoice items for this booking number will be returned	integer
masterId	optional	Booking number, when specified, only invoice items for this booking group will be returned	integer
invoiceId	optional	Invoice number, when specified, only invoice items for this invoice number will be returned	integer
invoiceeId	optional	Assigned Invoicee, when specified, only invoice items for this invoicee will be returned. Invoicee Id's are specified by an integer, see JSON getInvoicees, an empty string "" will return unassigned invoice items, false will return both assigned and unassigned invoice items. If the dateFrom parameter is not specified, this option will return invoice items created in the previous 24 hours.	integer or empty string "" or false.
dateFrom	optional	Date, when specified, only invoice items created after this date will be returned	date/time in "2016-12-31 14:37:15" format
dateTo	optional	Date, when specified, only invoice items created before this date will be returned	date/time in "2016-12-31 14:37:15" format
incBook	optional	if true, currency, invoiceId, roomId, propId and ownerId of the invoice item is included in the response

One of bookId, masterId, invoiceId or invoiceeId must be specified. invoiceeId=false will return invoices which are not assigned to an invoicee.

Example Request

{
    "authentication": {
        "apiKey": "apiKeyAsSetInAccountSettings",
        "propKey": "propKeyAsSetForTheProperty"
    },
    "bookId": false,
    "masterId": false,
    "invoiceId": false,
    "invoiceeId": false,
    "dateFrom": false,
    "dateTo": false,
    "incBook": false
}