index

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

ParameterUsageDescriptionValues
apiKeyrequiredAccount apiKeystring
propKeyrequiredProperty apiKeystring
bookIdoptionalBooking number, when specified, only invoice items for this booking number will be returnedinteger
masterIdoptionalBooking number, when specified, only invoice items for this booking group will be returnedinteger
invoiceIdoptionalInvoice number, when specified, only invoice items for this invoice number will be returnedinteger
invoiceeIdoptionalAssigned 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.
dateFromoptionalDate, when specified, only invoice items created after this date will be returneddate/time in '2016-12-31 14:37:15' format
dateTooptionalDate, when specified, only invoice items created before this date will be returneddate/time in '2016-12-31 14:37:15' format

Example Data

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