GL Account Balance by Date

Prev Next
Get
/public/v1/accounting/gl-account-balances/{date}

Retrieves GL account balances as of specified date

Security

The requesting user must have the following permissions to retrieve GL account balances:

  • General Ledger → GL Accounts → View GL Accounts
  • 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.

Path parameters
date
string (date) Required

As of date

Query parameters
locationNumbers
string

Location numbers to filter by

legalEntityNumbers
string

Legal entity numbers to filter by

glAccountNumbers
string
glAccountNames
string
glTypeNames
string
pageSize
integer (int32)

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

Minimum1.0
Maximum250.0
Default250
continuationToken
string
Responses
200

GL account balances

Expand All
object
date
string (date)

The date the balances were calculated as of.

locations
Array of object | null

Locations in this page. pageSize pages locations, not GL accounts.

object
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

legalEntity
object (GlAccountBalanceLegalEntity)
id
string (uuid)

Legal entity identifier.

name
string | null

Legal entity name.

number
string | null

Legal entity number.

glAccounts
Array of object | null

GL account balances for this location. Not paged — every GL account for the location is returned.

object
id
string (uuid)

GL account identifier.

number
string | null

GL account number.

name
string | null

GL account name.

type
string | null

GL account type, for example "Equity" or "Current Asset".

balance
number

Total balance as of the requested date.

approvedBalance
number

Portion of the balance from approved transactions.

unapprovedBalance
number

Portion of the balance from unapproved transactions.

count
integer (int64)

Number of locations returned in this page.

nextLink
string | null

URL to retrieve the next page of locations, or null when this is the last page.

Expand All
object
date
string (date)

The date the balances were calculated as of.

locations
Array of object | null

Locations in this page. pageSize pages locations, not GL accounts.

object
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

legalEntity
object (GlAccountBalanceLegalEntity)
id
string (uuid)

Legal entity identifier.

name
string | null

Legal entity name.

number
string | null

Legal entity number.

glAccounts
Array of object | null

GL account balances for this location. Not paged — every GL account for the location is returned.

object
id
string (uuid)

GL account identifier.

number
string | null

GL account number.

name
string | null

GL account name.

type
string | null

GL account type, for example "Equity" or "Current Asset".

balance
number

Total balance as of the requested date.

approvedBalance
number

Portion of the balance from approved transactions.

unapprovedBalance
number

Portion of the balance from unapproved transactions.

count
integer (int64)

Number of locations returned in this page.

nextLink
string | null

URL to retrieve the next page of locations, or null when this is the last page.

Expand All
object
date
string (date)

The date the balances were calculated as of.

locations
Array of object | null

Locations in this page. pageSize pages locations, not GL accounts.

object
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

legalEntity
object (GlAccountBalanceLegalEntity)
id
string (uuid)

Legal entity identifier.

name
string | null

Legal entity name.

number
string | null

Legal entity number.

glAccounts
Array of object | null

GL account balances for this location. Not paged — every GL account for the location is returned.

object
id
string (uuid)

GL account identifier.

number
string | null

GL account number.

name
string | null

GL account name.

type
string | null

GL account type, for example "Equity" or "Current Asset".

balance
number

Total balance as of the requested date.

approvedBalance
number

Portion of the balance from approved transactions.

unapprovedBalance
number

Portion of the balance from unapproved transactions.

count
integer (int64)

Number of locations returned in this page.

nextLink
string | null

URL to retrieve the next page of locations, or null when this is the last page.

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.