MarginEdge · Schema

GetGroupCategoriesResponseModel

GetGroupCategoriesResponseModel schema from MarginEdge Public API

RestaurantBack OfficeInvoicesInventoryAccountingReporting

Properties

Name Type Description
groupCategories array List of group categories accessible to the user
View JSON Schema on GitHub

JSON Schema

public-api-get-group-categories-response-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/marginedge/refs/heads/main/json-schema/public-api-get-group-categories-response-model-schema.json",
  "title": "GetGroupCategoriesResponseModel",
  "description": "GetGroupCategoriesResponseModel schema from MarginEdge Public API",
  "type": "object",
  "properties": {
    "groupCategories": {
      "type": "array",
      "description": "List of group categories accessible to the user",
      "items": {
        "type": "object",
        "properties": {
          "companyId": {
            "type": "number",
            "description": "Unique identifier of the company this category belongs to",
            "example": 12345
          },
          "conceptName": {
            "type": "string",
            "description": "Name of the concept",
            "example": "Sample Concept"
          },
          "companyName": {
            "type": "string",
            "description": "Name of the company",
            "example": "Sample Company"
          },
          "name": {
            "type": "string",
            "description": "Name of the category",
            "example": "Sample Name"
          },
          "conceptId": {
            "type": "number",
            "description": "Unique identifier of the concept this category belongs to",
            "example": 12345
          },
          "permission": {
            "type": "string",
            "description": "Permission level for the category (PUBLIC or RESTRICTED)",
            "example": "example"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the category (UUID)",
            "example": "me--9f3a2b"
          }
        }
      }
    }
  }
}