LogoLogo
  • Introduction
    • 👋Overview
    • 🤷Target Audience
    • ✨Features
  • Getting started
    • 🖥️System Requirements
    • 📦Installation
    • ⚙️Configuration
    • 🔧Setup Routine
  • Fundementals
    • 🎎Roles
    • 🌏Countries and time zones
    • ♻️Scheduletask concept
    • 💰Payment Service Provider
    • ✏️Administration
      • 🔵Sales
        • 👥Customers
        • 📥Invoices
        • 📋Plans
        • 🧊Modules
      • 🟢System
        • 🎛️System settings
        • ⛓️API Settings
        • 🌐Languages
        • 🪙Currencies
        • 🏳️Countries
        • 📂Mappings
        • 💬Translations
        • 🪧Widgets
    • 🖱️User guide
      • 🔐Customer rights
      • 🔗Customer Navigation
      • 📃Edit profile
      • 🔑Reset password
      • 🏨Edit company
      • ⚡Manage users
      • 👔Manage tenants
      • 📨View invoices
      • 💸Add payment method
      • 🪧Manage plans
      • 📦Manage modules
      • 🔔Notifications
  • Development
    • 🛠️Local development
    • 📂Folder structure
      • 🗄️Application.cfc
    • 💡Develop with saaster
      • 🎇General services
        • 💼Mappings and rigths management
        • ↩️Redirects
        • 👤Customer specific sessions
        • 〽️Global variable "getCustomerData"
      • 🌐Global functions
        • ⚙️getTrans()
        • ⚙️getAlert()
        • ⚙️logWrite()
        • ⚙️getTime()
      • 🧊Developing the main application
      • 📦Developing modules
  • API
    • ⚒️API: Get started
    • 📂Resources
      • 📄authenticate
      • 📄getCurrentModules
      • 📄getCurrentPlan
      • 📄getPlanFeatureSetting
Powered by GitBook
On this page
  • Description
  • Header parameters
  • Response
  1. API
  2. Resources

getCurrentModules

Description

Retrieves all the modules that the customer has subscribed to.

Header parameters

Name
Info
Required

customerID

ID of customer

language

Language in ISO standard

lngID

Language ID

currencyID

ID off currency

Response

array [
    struct {
        "includedInCurrentPlan": boolean,
        "moduleData": struct {
            "itsFree": number,
            "vat_text_onetime": string,
            "bookingLinkY": string,
            "vatType": number,
            "priceYearly": number,
            "name": string,
            "includedInPlans": array [],
            "picture": string,
            "priceYearlyAfterVAT": string,
            "description": string,
            "priceMonthlyAfterVAT": string,
            "currencySign": string,
            "isNet": number,
            "shortdescription": string,
            "bookingLinkO": string,
            "vat_text_monthly": string,
            "vat_text_yearly": string,
            "bookingLinkM": string,
            "priceOnetime": number,
            "table_prefix": string,
            "moduleID": number,
            "testDays": number,
            "vat": number,
            "bookable": number,
            "priceMonthly": number,
            "active": number,
            "priceOneTimeAfterVAT": string,
            "settingPath": string,
            "currency": string,
            "currencyID": number
        },
        "invoiceID": string,
        "modulStatus": struct {
            "endDate": string,
            "recurring": string,
            "startDate": string,
            "statusText": string,
            "status": string,
            "bookingID": number,
            "statusTitle": string,
            "fontColor": string
        },
        "moduleID": number
    }
]
PreviousauthenticateNextgetCurrentPlan

Last updated 2 years ago

📂
📄