> ## Documentation Index
> Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GL Accounts

> Retrieves GL Accounts

**Security**

The requesting user must have the following permission to retrieve GL accounts:

- General Ledger → GL Accounts → View GL Accounts

_Restricted-record access:_ accounts marked as restricted are returned only to users who also have General Ledger → GL Accounts → Access Restricted GL Accounts.

## OpenAPI

````json GET /public/v1/accounting/gl-accounts
{
  "openapi": "3.0.1",
  "info": {
    "title": "R365 Public API",
    "contact": {
      "name": "R365 Services Team",
      "email": "r365@restaurant365.com"
    },
    "version": "1.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/public/v1/accounting/gl-accounts": {
      "get": {
        "tags": [
          "accounting"
        ],
        "summary": "GL Accounts",
        "description": "Retrieves GL Accounts\n\n**Security**\n\nThe requesting user must have the following permission to retrieve GL accounts:\n\n- General Ledger → GL Accounts → View GL Accounts\n\n_Restricted-record access:_ accounts marked as restricted are returned only to users who also have General Ledger → GL Accounts → Access Restricted GL Accounts.",
        "parameters": [
          {
            "$ref": "#/components/parameters/TenantId"
          },
          {
            "name": "ModifiedOnStart",
            "in": "query",
            "description": "Modified On Start",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "ModifiedOnEnd",
            "in": "query",
            "description": "Modified On End",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "GlAccountNumbers",
            "in": "query",
            "description": "GL Account Numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "GlTypeNames",
            "in": "query",
            "description": "GL Types",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "OperationalReportCategories",
            "in": "query",
            "description": "Operational Reports Categories",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 250,
              "default": 250
            },
            "description": "Maximum number of top-level objects to return in one page."
          },
          {
            "name": "ContinuationToken",
            "in": "query",
            "description": "Continuation token for pagination",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "GL Accounts.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GlAccountsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range."
          },
          "401": {
            "description": "Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant."
          },
          "403": {
            "description": "Forbidden — the caller lacks the permission required for this operation."
          },
          "404": {
            "description": "Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired."
          },
          "409": {
            "description": "Conflict — the request conflicts with the current state of the resource and cannot be applied."
          },
          "422": {
            "description": "Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid."
          },
          "429": {
            "description": "Too Many Requests — the caller has exceeded the rate limit; retry after a short delay."
          },
          "500": {
            "description": "Internal Server Error — an unexpected error occurred while processing the request."
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "TenantId": {
        "name": "x-r365-context-tenant-id",
        "in": "header",
        "required": true,
        "description": "Identifies the R365 tenant the request applies to. Required on every request.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "GlAccountsResponse": {
        "type": "object",
        "properties": {
          "glAccounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GlAccount"
            },
            "description": "GL Accounts."
          },
          "nextLink": {
            "type": "string",
            "description": "Next Link for pagination.",
            "nullable": true
          }
        }
      },
      "GlAccount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "General Ledger Account identifier.",
            "format": "uuid"
          },
          "number": {
            "type": "string",
            "description": "General Ledger Account Number.",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "General Ledger Account Name.",
            "nullable": true
          },
          "glType": {
            "type": "string",
            "description": "General Ledger Account Type.",
            "nullable": true
          },
          "parentAccount": {
            "$ref": "#/components/schemas/ParentGLAccount"
          },
          "operationalReportCategory": {
            "type": "string",
            "description": "Operational Reports Category.",
            "nullable": true
          },
          "isStatAccount": {
            "type": "boolean",
            "description": "Indicates whether the stat Account flag is set."
          },
          "disableEntrySubtotal": {
            "type": "boolean",
            "description": "Indicates whether the disable Entry Subtotal flag is set."
          },
          "restrictedAccess": {
            "type": "boolean",
            "description": "Indicates whether the restricted Access flag is set."
          },
          "controlAccount": {
            "type": "boolean",
            "description": "Indicates whether the control Account flag is set."
          },
          "isBankAccount": {
            "type": "boolean",
            "description": "Whether this GL account is a bank account."
          },
          "budgetAs": {
            "type": "string",
            "description": "Budget As.",
            "nullable": true
          },
          "percentageOfBasedOn": {
            "type": "string",
            "description": "Percentage Of Based On.",
            "nullable": true
          },
          "budgetAsPercentageOf": {
            "type": "string",
            "description": "Budget As Percentage Of.",
            "nullable": true
          },
          "budgetPercentageOrAmount": {
            "type": "number",
            "description": "Budget Percent or Amount depending on BudgetAs.",
            "format": "decimal"
          },
          "createdOn": {
            "type": "string",
            "description": "Created Date.",
            "format": "date-time"
          },
          "createdBy": {
            "$ref": "#/components/schemas/SharedUserReference",
            "description": "User who created the gl account."
          },
          "modifiedOn": {
            "type": "string",
            "description": "Modified Date.",
            "format": "date-time"
          },
          "modifiedBy": {
            "$ref": "#/components/schemas/SharedUserReference",
            "description": "User who last modified the gl account."
          }
        }
      },
      "ParentGLAccount": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "General Ledger Account identifier.",
            "format": "uuid"
          },
          "number": {
            "type": "string",
            "description": "General Ledger Account Number.",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "General Ledger Account Name.",
            "nullable": true
          },
          "glType": {
            "type": "string",
            "description": "General Ledger Account Type.",
            "nullable": true
          }
        }
      },
      "SharedUserReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "User identifier.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Name.",
            "nullable": true
          }
        },
        "description": "A reference to the id and name of a User."
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "Bearer"
      }
    }
  }
}
````