Bank Accounts

Prev Next
Get
/public/v1/accounting/general-ledger/bank-accounts

Retrieves bank accounts for the current tenant with filtering and pagination support

Security

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

  • Banking → Bank Accounts → View Bank Accounts

Masked fields: the bank account number and routing number return masked (**** followed by the last four characters) unless the user also has:

  • Banking → Bank Accounts → View Bank Account Numbers
  • Banking → Bank Accounts → View Routing Numbers
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)

ISO-8601 UTC timestamp lower bound (inclusive). Returns accounts modified on or after this value

modifiedOnEnd
string (date-time)

ISO-8601 UTC timestamp upper bound (inclusive). Returns accounts modified on or before this value

pageSize
integer (int32)

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

Minimum1.0
Maximum250.0
Default250
continuationToken
string

Continuation token for retrieving the next page of results

Responses
200

Paginated list of bank accounts.

Expand All
object

Response containing Bank Accounts with pagination support.

bankAccounts
Array of object | null

Bank Accounts.

object

Public API DTO for a bank account returned by the GET bank-accounts endpoint.

id
string (uuid)

Bank Account identifier.

name
string | null

Bank Account Name (GL Account name).

number
string | null

Bank Account Number (GL Account number).

parentAccount
object (ParentBankAccount)

Reference to a parent bank account.

id
string (uuid)

Parent account identifier.

name
string | null

Parent account name.

number
string | null

Parent account number.

glType
string | null

Parent account GL type.

glType
string | null

GL Type name.

legalEntity
object (BankAccountEntityReference)

Reference to an entity with id and name.

id
string (uuid)

Entity identifier.

name
string | null

Entity name.

number
string | null

Entity number (optional, populated for legal entities).

bank
object (EntityReferenceGuid)

Base class for entity references.

id
string (uuid)

The identifier of this entity.

name
string | null

The name of this entity.

accountType
string | null

Account type (Checking, Savings, etc.).

bankAccountNumber
string | null

Bank account number (masked based on permissions).

bankRoutingNumber
string | null

Bank routing number.

bankIcd
integer (int64) | null

Bank ICD (internal bank code).

positivePayBankID
string | null

Positive Pay Bank identifier.

achImmediateOrigin
string | null

ACH immediate origin.

achCompanyId
string | null

ACH company identifier.

achCompanyName
string | null

ACH company name.

defaultLocation
object (BankAccountLocationReference)

Reference to a location with legal entity.

id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

legalEntity
object (BankAccountEntityReference)

Reference to an entity with id and name.

id
string (uuid)

Entity identifier.

name
string | null

Entity name.

number
string | null

Entity number (optional, populated for legal entities).

createdOn
string (date-time)

Created date.

createdBy
object (EntityReferenceGuid)

Base class for entity references.

id
string (uuid)

The identifier of this entity.

name
string | null

The name of this entity.

modifiedOn
string (date-time) | null

Modified date.

modifiedBy
object (EntityReferenceGuid)

Base class for entity references.

id
string (uuid)

The identifier of this entity.

name
string | null

The name of this entity.

nextLink
string | null

URL to retrieve the next page of results, or null if 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.