List of API Endpoints

  • Below are the HTTP endpoints available in JSON format.
  • Some endpoints will have validation, or will only be accessible under certain conditions
  • Files are not uploaded via REST endpints, but through a separate uploads endpoint
  • Rest READ endpoints are disabled - you shoud use REST list endpoints to retrieve items only.¬† READ endpoints will respond with a message stating as much
  • Many non REST endpoints, and errors, will be returned in a standardised format¬†
    { code: statusCode, status: statusText, message: message, detail: detail }
[
    {
        "path": "/",
        "methods": [
            "GET"
        ],
        "description": "Connectivity test and authentication status"
    },
    {
        "path": "/usersExist",
        "methods": [
            "GET"
        ],
        "description": "Check whether the default admin is present - used for first run to check if users need to be created"
    },
    {
        "path": "/createDefaultAdmin",
        "methods": [
            "POST"
        ],
        "description": "Create the first user on the system - used during first run to create defaultadmin"
    },
    {
        "path": "/authenticate",
        "methods": [
            "POST"
        ],
        "description": "Log a user in and return a JWT token"
    },
    {
        "path": "/myPermissions",
        "methods": [
            "GET"
        ],
        "description": "Returns the currently authenticated users permissions"
    },
    {
        "path": "/availablePermissions",
        "methods": [
            "GET"
        ],
        "description": "Returns a list of all available permissions"
    },
    {
        "path": "/info",
        "methods": [
            "GET"
        ],
        "description": "Returns the environment info of the system for debugging - dumped from process.env in node.js"
    },
    {
        "path": "/attachments",
        "methods": [
            "POST"
        ],
        "description": "Attachment object REST Create"
    },
    {
        "path": "/attachments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Attachment REST Read"
    },
    {
        "path": "/attachments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Attachment REST Update"
    },
    {
        "path": "/attachments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Attachment REST Delete"
    },
    {
        "path": "/attachments",
        "methods": [
            "GET"
        ],
        "description": "Attachment REST List"
    },
    {
        "path": "/bankAccounts",
        "methods": [
            "POST"
        ],
        "description": "Bank Account REST Create"
    },
    {
        "path": "/bankAccounts/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Bank Account REST Read"
    },
    {
        "path": "/bankAccounts/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Bank Account REST Update"
    },
    {
        "path": "/bankAccounts/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Bank Account REST Delete"
    },
    {
        "path": "/bankAccounts",
        "methods": [
            "GET"
        ],
        "description": "Bank Account REST List"
    },
    {
        "path": "/bankAdjustments",
        "methods": [
            "POST"
        ],
        "description": "Bank Adjustment REST Create"
    },
    {
        "path": "/bankAdjustments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Bank Adjustment REST Read"
    },
    {
        "path": "/bankAdjustments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Bank Adjustment REST Update"
    },
    {
        "path": "/bankAdjustments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Bank Adjustment REST Delete"
    },
    {
        "path": "/bankAdjustments",
        "methods": [
            "GET"
        ],
        "description": "Bank Adjustment REST List"
    },
    {
        "path": "/categories",
        "methods": [
            "POST"
        ],
        "description": "Category REST Create"
    },
    {
        "path": "/categories/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Category REST Read"
    },
    {
        "path": "/categories/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Category REST Update"
    },
    {
        "path": "/categories/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Category REST Delete"
    },
    {
        "path": "/categories",
        "methods": [
            "GET"
        ],
        "description": "Category REST List"
    },
    {
        "path": "/clockInOuts",
        "methods": [
            "POST"
        ],
        "description": "ClockInOut REST Create"
    },
    {
        "path": "/clockInOuts/:uuid",
        "methods": [
            "GET"
        ],
        "description": "ClockInOut REST  Read"
    },
    {
        "path": "/clockInOuts/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "ClockInOut REST Update"
    },
    {
        "path": "/clockInOuts/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "ClockInOut REST Delete"
    },
    {
        "path": "/clockInOuts",
        "methods": [
            "GET"
        ],
        "description": "ClockInOut REST List"
    },
    {
        "path": "/configurations",
        "methods": [
            "POST"
        ],
        "description": "Configuration REST Create"
    },
    {
        "path": "/configurations/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Configuration REST Read"
    },
    {
        "path": "/configurations/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Configuration REST Update"
    },
    {
        "path": "/configurations/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Configuration REST Delete"
    },
    {
        "path": "/configurations",
        "methods": [
            "GET"
        ],
        "description": "Configuration REST List"
    },
    {
        "path": "/contacts",
        "methods": [
            "POST"
        ],
        "description": "Contact REST Create"
    },
    {
        "path": "/contacts/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Contact REST Read"
    },
    {
        "path": "/contacts/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Contact REST Update"
    },
    {
        "path": "/contacts/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Contact REST DELETE"
    },
    {
        "path": "/contacts",
        "methods": [
            "GET"
        ],
        "description": "Contact REST List"
    },
    {
        "path": "/discounts",
        "methods": [
            "POST"
        ],
        "description": "Discount REST Create"
    },
    {
        "path": "/discounts/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Discount REST Read"
    },
    {
        "path": "/discounts/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Discount REST Update"
    },
    {
        "path": "/discounts/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Discount REST Delete"
    },
    {
        "path": "/discounts",
        "methods": [
            "GET"
        ],
        "description": "Discount REST List"
    },
    {
        "path": "/expenses",
        "methods": [
            "POST"
        ],
        "description": "Expense REST Create"
    },
    {
        "path": "/expenses/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Expense REST Read"
    },
    {
        "path": "/expenses/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Expense REST Update"
    },
    {
        "path": "/expenses/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Expense REST Delete"
    },
    {
        "path": "/expenses",
        "methods": [
            "GET"
        ],
        "description": "Expense REST List"
    },
    {
        "path": "/floatAdjustments",
        "methods": [
            "POST"
        ],
        "description": "Float Adjustment REST Create"
    },
    {
        "path": "/floatAdjustments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Float Adjustment REST Read"
    },
    {
        "path": "/floatAdjustments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Float Adjustment REST Update"
    },
    {
        "path": "/floatAdjustments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Float Adjustment REST Delete"
    },
    {
        "path": "/floatAdjustments",
        "methods": [
            "GET"
        ],
        "description": "Float Adjustment REST List"
    },
    {
        "path": "/payments",
        "methods": [
            "POST"
        ],
        "description": "Payment REST Create"
    },
    {
        "path": "/payments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Payment REST Read"
    },
    {
        "path": "/payments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Payment REST Update"
    },
    {
        "path": "/payments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Payment REST Delete"
    },
    {
        "path": "/payments",
        "methods": [
            "GET"
        ],
        "description": "Payment REST List"
    },
    {
        "path": "/paymentMethods",
        "methods": [
            "POST"
        ],
        "description": "Payment Method REST Create"
    },
    {
        "path": "/paymentMethods/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Payment Method REST Read"
    },
    {
        "path": "/paymentMethods/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Payment Method REST Update"
    },
    {
        "path": "/paymentMethods/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Payment Method REST Delete"
    },
    {
        "path": "/paymentMethods",
        "methods": [
            "GET"
        ],
        "description": "Payment Method REST List"
    },
    {
        "path": "/permissions",
        "methods": [
            "POST"
        ],
        "description": "User Permission REST Create"
    },
    {
        "path": "/permissions/:uuid",
        "methods": [
            "GET"
        ],
        "description": "User Permission REST Read"
    },
    {
        "path": "/permissions/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "User Permission REST Update"
    },
    {
        "path": "/permissions/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "User Permission REST Delete"
    },
    {
        "path": "/permissions",
        "methods": [
            "GET"
        ],
        "description": "User Permission REST List"
    },
    {
        "path": "/printRuleSets",
        "methods": [
            "POST"
        ],
        "description": "Print Rule Set REST Create"
    },
    {
        "path": "/printRuleSets/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Print Rule Set REST Read"
    },
    {
        "path": "/printRuleSets/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Print Rule Set REST Update"
    },
    {
        "path": "/printRuleSets/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Print Rule Set REST Delete"
    },
    {
        "path": "/printRuleSets",
        "methods": [
            "GET"
        ],
        "description": "Print Rule Set REST List"
    },
    {
        "path": "/printables",
        "methods": [
            "POST"
        ],
        "description": "Printable REST Create"
    },
    {
        "path": "/printables/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Printable REST Read"
    },
    {
        "path": "/printables/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Printable REST Update"
    },
    {
        "path": "/printables/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Printable REST Delete"
    },
    {
        "path": "/printables",
        "methods": [
            "GET"
        ],
        "description": "Printable REST List"
    },
    {
        "path": "/printers",
        "methods": [
            "POST"
        ],
        "description": "Printer REST Create"
    },
    {
        "path": "/printers/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Printer REST Read"
    },
    {
        "path": "/printers/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Printer REST Update"
    },
    {
        "path": "/printers/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Printer REST Delete"
    },
    {
        "path": "/printers",
        "methods": [
            "GET"
        ],
        "description": "Printer REST List"
    },
    {
        "path": "/products",
        "methods": [
            "POST"
        ],
        "description": "Product REST Create"
    },
    {
        "path": "/products/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Product REST Read"
    },
    {
        "path": "/products/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Product REST Update"
    },
    {
        "path": "/products/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Product REST Delete"
    },
    {
        "path": "/products",
        "methods": [
            "GET"
        ],
        "description": "Product REST Read"
    },
    {
        "path": "/purchaseExpenses",
        "methods": [
            "POST"
        ],
        "description": "Purchase Expense REST Create - same as Expense REST sans pagination"
    },
    {
        "path": "/purchaseExpenses/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Purchase Expense REST Read - same as Expense REST sans pagination"
    },
    {
        "path": "/purchaseExpenses/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Purchase Expense REST Update - same as Expense REST sans pagination"
    },
    {
        "path": "/purchaseExpenses/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Purchase Expense REST Delete - same as Expense REST sans pagination"
    },
    {
        "path": "/purchaseExpenses",
        "methods": [
            "GET"
        ],
        "description": "Purchase Expense REST List - same as Expense REST sans pagination"
    },
    {
        "path": "/purchases",
        "methods": [
            "POST"
        ],
        "description": "Purchase REST Create"
    },
    {
        "path": "/purchases/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Purchase REST Read"
    },
    {
        "path": "/purchases/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Purchase REST Update"
    },
    {
        "path": "/purchases/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Purchase REST Delete"
    },
    {
        "path": "/purchases",
        "methods": [
            "GET"
        ],
        "description": "Purchase REST List"
    },
    {
        "path": "/reconciliations",
        "methods": [
            "POST"
        ],
        "description": "Reconciliation REST Create"
    },
    {
        "path": "/reconciliations/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Reconciliation REST Read"
    },
    {
        "path": "/reconciliations/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Reconciliation REST Update"
    },
    {
        "path": "/reconciliations/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Reconciliation REST Delete"
    },
    {
        "path": "/reconciliations",
        "methods": [
            "GET"
        ],
        "description": "Reconciliation REST List"
    },
    {
        "path": "/salePayments",
        "methods": [
            "POST"
        ],
        "description": "Sale Payment REST Create - same as Payment REST sans pagination"
    },
    {
        "path": "/salePayments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Sale Payment REST Read - same as Payment REST sans pagination"
    },
    {
        "path": "/salePayments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Sale Payment REST Update - same as Payment REST sans pagination"
    },
    {
        "path": "/salePayments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Sale Payment REST Delete - same as Payment REST sans pagination"
    },
    {
        "path": "/salePayments",
        "methods": [
            "GET"
        ],
        "description": "Sale Payment REST List - same as Payment REST sans pagination"
    },
    {
        "path": "/sales",
        "methods": [
            "POST"
        ],
        "description": "Sale REST Create"
    },
    {
        "path": "/sales/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Sale REST Read"
    },
    {
        "path": "/sales/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Sale REST Update"
    },
    {
        "path": "/sales/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Sale REST Delete"
    },
    {
        "path": "/sales",
        "methods": [
            "GET"
        ],
        "description": "Sale REST List"
    },
    {
        "path": "/scheduledReports",
        "methods": [
            "POST"
        ]
    },
    {
        "path": "/scheduledReports/:uuid",
        "methods": [
            "GET"
        ]
    },
    {
        "path": "/scheduledReports/:uuid",
        "methods": [
            "PUT"
        ]
    },
    {
        "path": "/scheduledReports/:uuid",
        "methods": [
            "DELETE"
        ]
    },
    {
        "path": "/scheduledReports",
        "methods": [
            "GET"
        ]
    },
    {
        "path": "/selectables",
        "methods": [
            "POST"
        ],
        "description": "Selectable REST Create"
    },
    {
        "path": "/selectables/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Selectable REST Read"
    },
    {
        "path": "/selectables/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Selectable REST Update"
    },
    {
        "path": "/selectables/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Selectable REST Delete"
    },
    {
        "path": "/selectables",
        "methods": [
            "GET"
        ],
        "description": "Selectable REST List"
    },
    {
        "path": "/stockAdjustments",
        "methods": [
            "POST"
        ],
        "description": "Stock Adjustment REST Create"
    },
    {
        "path": "/stockAdjustments/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Stock Adjustment REST Read"
    },
    {
        "path": "/stockAdjustments/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Stock Adjustment REST Update"
    },
    {
        "path": "/stockAdjustments/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Stock Adjustment REST Delete"
    },
    {
        "path": "/stockAdjustments",
        "methods": [
            "GET"
        ],
        "description": "Stock Adjustment REST List"
    },
    {
        "path": "/taxClasses",
        "methods": [
            "POST"
        ],
        "description": "Tax Class REST Create"
    },
    {
        "path": "/taxClasses/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Tax Class REST Read"
    },
    {
        "path": "/taxClasses/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Tax Class REST Update"
    },
    {
        "path": "/taxClasses/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Tax Class REST Delete"
    },
    {
        "path": "/taxClasses",
        "methods": [
            "GET"
        ],
        "description": "Tax Class REST List"
    },
    {
        "path": "/terminals",
        "methods": [
            "POST"
        ],
        "description": "Terminal REST Create"
    },
    {
        "path": "/terminals/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Terminal REST Read"
    },
    {
        "path": "/terminals/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Terminal REST Update"
    },
    {
        "path": "/terminals/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Terminal REST Delete"
    },
    {
        "path": "/terminals",
        "methods": [
            "GET"
        ],
        "description": "Terminal REST List"
    },
    {
        "path": "/transfers",
        "methods": [
            "POST"
        ],
        "description": "Transfer REST Create"
    },
    {
        "path": "/transfers/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Transfer REST Read"
    },
    {
        "path": "/transfers/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Transfer REST Update"
    },
    {
        "path": "/transfers/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Transfer REST Delete"
    },
    {
        "path": "/transfers",
        "methods": [
            "GET"
        ],
        "description": "Transfer REST List"
    },
    {
        "path": "/users",
        "methods": [
            "POST"
        ],
        "description": "User REST Create"
    },
    {
        "path": "/users/:uuid",
        "methods": [
            "GET"
        ],
        "description": "User REST Read"
    },
    {
        "path": "/users/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "User REST Update"
    },
    {
        "path": "/users/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "User REST Delete"
    },
    {
        "path": "/users",
        "methods": [
            "GET"
        ],
        "description": "User REST List"
    },
    {
        "path": "/vbaReports",
        "methods": [
            "POST"
        ],
        "description": "VBA Report REST Create"
    },
    {
        "path": "/vbaReports/:uuid",
        "methods": [
            "GET"
        ],
        "description": "VBA Report REST Read"
    },
    {
        "path": "/vbaReports/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "VBA Report REST Update"
    },
    {
        "path": "/vbaReports/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "VBA Report REST Delete"
    },
    {
        "path": "/vbaReports",
        "methods": [
            "GET"
        ],
        "description": "VBA Report REST List"
    },
    {
        "path": "/webhooks",
        "methods": [
            "POST"
        ],
        "description": "Webhook REST Create"
    },
    {
        "path": "/webhooks/:uuid",
        "methods": [
            "GET"
        ],
        "description": "Webhook REST Read"
    },
    {
        "path": "/webhooks/:uuid",
        "methods": [
            "PUT"
        ],
        "description": "Webhook REST Update"
    },
    {
        "path": "/webhooks/:uuid",
        "methods": [
            "DELETE"
        ],
        "description": "Webhook REST Delete"
    },
    {
        "path": "/webhooks",
        "methods": [
            "GET"
        ],
        "description": "Webhook REST List"
    },
    {
        "path": "/upload",
        "methods": [
            "POST"
        ],
        "description": "Upload a File and attach it to a database item by uuid"
    },
    {
        "path": "/upload/:id",
        "methods": [
            "GET"
        ],
        "description": "Get an uploaded file by it's id (name)"
    },
    {
        "path": "/preClockInOut",
        "methods": [
          "POST"
        ],
        "description": "Pre-clock actions, accepts user by pin auth - returns the user if found and whether they have a pending clock-in"
      },
      {
        "path": "/doClockInOut",
        "methods": [
          "POST"
        ],
        "description": "Creates a clock in or out for the user if found by pin or auth"
      },
      {
        "path": "/clearPrintQueue",
        "methods": [
          "GET"
        ],
        "description": "Clear the printing queues"
      },
      {
        "path": "/systemPrinters",
        "methods": [
          "GET"
        ],
        "description": "List available system printers (Printers installed in the OS)"
      },
      {
        "path": "/printDocumentPdf",
        "methods": [
          "POST"
        ],
        "description": "Returns a PDF document containing a rendering of the supplied html"
      },
      {
        "path": "/print",
        "methods": [
          "POST"
        ],
        "description": "Print receipt and/or invoices for supplied sale/payment/purchase/expense according to print rules and defaults"
      },
      {
        "path": "/printPrintable",
        "methods": [
          "POST"
        ],
        "description": "Prints a pdf which has been uploaded as a printable by it's filename"
      },
    {
        "path": "/sendEmailAlert",
        "methods": [
            "POST"
        ],
        "description":"Send an email via KoalaBrain Online - Used for emailing invoices"
    },
    {
        "path": "/calculateStock",
        "methods": [
          "GET"
        ],
        "description": "Calculate stock level for given product"
      },
      {
        "path": "/calculateFloat",
        "methods": [
          "GET"
        ],
        "description": "Calculate float for the given terminal"
      },
      {
        "path": "/calculateBanking",
        "methods": [
          "GET"
        ],
        "description": "calculate balance for given bank account"
      },
      {
        "path": "/calculateReconciliation",
        "methods": [
          "GET"
        ],
        "description": "Calculate the value for a given reconciliation"
      },
      {
        "path": "/notifications",
        "methods": [
          "GET"
        ],
        "description": "Get any available notifications"
      },
      {
        "path": "/generateVbaReport",
        "methods": [
          "POST"
        ],
        "description": "Return a macro enabled excel file containing the data from a given report"
      },
      {
        "path": "/getHistory",
        "methods": [
          "GET"
        ],
        "description": "Get the revision history for the given item"
      },
    {
        "path": "/getDeletedHistory",
        "methods": [
            "GET"
        ],
        "description":"Get revision history for deleted items of the given model"
    },
    {
        "path": "/generateEasyReportHtml",
        "methods": [
            "POST"
        ],
        "description":"Generate the HTML for an Easy Report"
    },
    {
        "path": "/generateEasyReportPdf",
        "methods": [
            "POST"
        ],
        "description":"Generate a PDF file for the given Easy Report"
    },
    {
        "path": "/generateInvoiceHtml",
        "methods": [
            "POST"
        ],
        "description":"Generate the HTML for a sale or purchase invoice"
    },
    {
        "path": "/generateInvoicePdf",
        "methods": [
            "POST"
        ],
        "description":"Generate a PDF file for a sale or invoice"
    },
    {
        "path": "/tunnelCheck",
        "methods": [
          "GET"
        ],
        "description": "TBA"
      },
      {
        "path": "/whitelabel",
        "methods": [
          "GET"
        ],
        "description": "Returns the information used to generate the contents of the support page"
      },
      {
        "path": "/whitelabelImage",
        "methods": [
          "GET"
        ],
        "description": "Returns the image used to whitelabel/brand the application"
      },
    {
        "path": "/promptForLicenseNextRestart",
        "methods": [
            "GET"
        ],
        "description":"On accessing this endpoint with the correct permission, the license input screen will be set to display at next application start"
    },
    {
        "path": "/endpoints",
        "methods": [
          "GET"
        ],
        "description": "Lists all of the available endpoints (Ie. this document, sans descriptions)"
      }
]