MarginEdge · Schema

GetCategoriesResponseModel

GetCategoriesResponseModel schema from MarginEdge Public API

RestaurantBack OfficeInvoicesInventoryAccountingReporting

Properties

Name Type Description
nextPage string Unique key for the next page of results
categories array
View JSON Schema on GitHub

JSON Schema

public-api-get-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-categories-response-model-schema.json",
  "title": "GetCategoriesResponseModel",
  "description": "GetCategoriesResponseModel schema from MarginEdge Public API",
  "type": "object",
  "properties": {
    "nextPage": {
      "type": "string",
      "description": "Unique key for the next page of results",
      "example": "eyJsYXN0SWQiOiAiMTIzNDUifQ=="
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "categoryType": {
            "type": "string",
            "description": "Type of category (Food, Beer, Wine, Liquor, N/A Bev, Retail, Other, Labor, or a custom category type)",
            "example": "Food"
          },
          "accountingCode": {
            "type": "number",
            "description": "Account code for the category in the integrated accounting system",
            "example": 5010
          },
          "categoryName": {
            "type": "string",
            "description": "Name of the category in MarginEdge",
            "example": "Sample Category"
          },
          "categoryId": {
            "type": "string",
            "description": "Identifier of the category in MarginEdge",
            "example": "me-category-9f3a2b"
          }
        }
      }
    }
  }
}