GL Accounts

Prev Next
Get
/public/v1/accounting/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.

Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
ModifiedOnStart
string (date-time)

Modified On Start

ModifiedOnEnd
string (date-time)

Modified On End

GlAccountNumbers
string

GL Account Numbers

GlTypeNames
string

GL Types

OperationalReportCategories
string

Operational Reports Categories

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
ContinuationToken
string

Continuation token for pagination

Responses
200

GL Accounts.

Expand All
object
glAccounts
Array of object (GlAccount)

GL Accounts.

object
id
string (uuid)

General Ledger Account identifier.

number
string | null

General Ledger Account Number.

name
string | null

General Ledger Account Name.

glType
string | null

General Ledger Account Type.

parentAccount
object (ParentGLAccount)
id
string (uuid)

General Ledger Account identifier.

number
string | null

General Ledger Account Number.

name
string | null

General Ledger Account Name.

glType
string | null

General Ledger Account Type.

operationalReportCategory
string | null

Operational Reports Category.

isStatAccount
boolean

Indicates whether the stat Account flag is set.

disableEntrySubtotal
boolean

Indicates whether the disable Entry Subtotal flag is set.

restrictedAccess
boolean

Indicates whether the restricted Access flag is set.

controlAccount
boolean

Indicates whether the control Account flag is set.

isBankAccount
boolean

Whether this GL account is a bank account.

budgetAs
string | null

Budget As.

percentageOfBasedOn
string | null

Percentage Of Based On.

budgetAsPercentageOf
string | null

Budget As Percentage Of.

budgetPercentageOrAmount
number (decimal)

Budget Percent or Amount depending on BudgetAs.

createdOn
string (date-time)

Created Date.

createdBy
object (SharedUserReference)

A reference to the id and name of a User.

id
string (uuid)

User identifier.

name
string | null

Name.

modifiedOn
string (date-time)

Modified Date.

modifiedBy
object (SharedUserReference)

A reference to the id and name of a User.

id
string (uuid)

User identifier.

name
string | null

Name.

nextLink
string | null

Next Link for pagination.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.