List invoices

Invoice status: 0 unpaid 1 paid 2 cancelled 3 pending

Scope

Property Get / Property Set

Get invoices

Endpoint

GET https://yourdomain.com/bookyflow/api/listinvoices/{{property_id}}/

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "listinvoices": [
      {
        "id": 28,
        "cms_user_id": 93,
        "guest_id": 0,
        "status": 3,
        "raised_date": "2019-10-23 11:00:23",
        "due_date": "2019-10-23 11:00:23",
        "paid": "1970-01-01 00:00:01",
        "init_total": 50,
        "currencycode": "EUR",
        "contract_id": 79,
        "subscription": 0,
        "property_uid": 1,
        "is_commission": 0,
        "line_items": "Accommodation",
        "grand_total": 50,
        "guest_uid": 6,
        "tag": "15185494",
        "currency_code": "EUR",
        "approved": 1,
        "firstname": "asdf",
        "surname": "asdf",
        "imgColor": "orange",
        "Txtstatus": "Pending"
      },
      {
        "id": 22,
        "cms_user_id": 48,
        "guest_id": 0,
        "status": 3,
        "raised_date": "2019-09-10 14:37:33",
        "due_date": "2019-09-10 14:37:33",
        "paid": "1970-01-01 00:00:01",
        "init_total": 20.8,
        "currencycode": "EUR",
        "contract_id": 64,
        "subscription": 0,
  ...
  (Response truncated for brevity)
}

Get invoice details

Endpoint

GET 

Response Example

Status: OK (200)

{
  "data": {
    "listinvoicesdetails": [
      {
        "ID": "28",
        "RAISED": "2019-10-23 11:00:23",
        "DUE": "2019-10-23 11:00:23",
        "INITTOTAL": "50.00\u20ac",
        "CURRENCYCODE": "EUR",
        "STATUS": "3",
        "STATUS_TXT": "Pending",
        "STATUS_STATES": [
          "0 unpaid",
          "1 paid",
          "2 cancelled",
          "3 pending"
        ],
        "GRAND_TOTAL_INC_TAX": "50.00\u20ac",
        "GRAND_TOTAL_EX_TAX": "41.67\u20ac",
        "GRAND_TOTAL_TAX": "8.33\u20ac",
        "OUTSTANDING_TOTAL": "50.00\u20ac",
        "LINE_ITEMS": [
          {
            "ID": "68",
            "LI_NAME": "Accommodation",
            "LI_DESCRIPTION": "(Wednesday, 23 October 2019 - Saturday, 26 October 2019)",
            "LI_INIT_PRICE": "41.67\u20ac",
            "LI_INIT_QTY": "1",
            "LI_INIT_DISCOUNT": "0.00\u20ac",
            "LI_INIT_TOTAL": "41.67\u20ac",
            "LI_INIT_TOTAL_INCLUSIVE": "50.00\u20ac",
            "LI_TAX_RATE": "20",
            "LI_TAX_CODE": "01",
            "LI_TAX_DESCRIPTION": "VAT",
            "LI_TAX_AMOUNT": "8.33\u20ac",
            "LI_INV_ID": "28",
            "CURRENCYCODE": "EUR"
          }
        ]
      }
  ...
  (Response truncated for brevity)
}

Get invoices between dates

Endpoint

GET https://yourdomain.com/bookyflow/api/listinvoices/{{property_id}}/{{invoice_start_date}}/{{invoice_end_date}}/

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "listinvoicesdate": [
      {
        "id": 28,
        "cms_user_id": 93,
        "guest_id": 0,
        "status": 3,
        "raised_date": "2019-10-23 11:00:23",
        "due_date": "2019-10-23 11:00:23",
        "paid": "1970-01-01 00:00:01",
        "init_total": 50,
        "currencycode": "EUR",
        "contract_id": 79,
        "subscription": 0,
        "property_uid": 1,
        "is_commission": 0,
        "line_items": "Accommodation",
        "grand_total": 50,
        "guest_uid": 6,
        "tag": "15185494",
        "currency_code": "EUR",
        "approved": 1,
        "firstname": "asdf",
        "surname": "asdf",
        "imgColor": "orange",
        "Txtstatus": "Pending"
      },
      {
        "id": 22,
        "cms_user_id": 48,
        "guest_id": 0,
        "status": 3,
        "raised_date": "2019-09-10 14:37:33",
        "due_date": "2019-09-10 14:37:33",
        "paid": "1970-01-01 00:00:01",
        "init_total": 20.8,
        "currencycode": "EUR",
        "contract_id": 64,
        "subscription": 0,
  ...
  (Response truncated for brevity)
}