Financial Account Statement Summary Object

The Financial Account Statement Summary object provides a condensed monthly statement for a Financial Account.

Attributes

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

accountHolderId

string (UUID)

ID of the account holder for the Financial Account. The account holder can be a Customer Account or Business Account.

currency

string, min length: 3, max length: 3

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code.

string (UUID)

ID of the statement.

financialAccountId

string (UUID)

ID of the Financial Account.

statementStartDate

string (date-time)

Start date of the statement period.

statementEndDate

string (date-time)

End date of the statement period.

statementCreatedDate

string (date-time)

Date and time the statement was created.

createdBy

string

Job that created the statement. Used internally by RocketKOR.

createdAt

string (date-time)

Date and time the statement was created. Used internally by RocketKOR.

openingBalance

number

Financial Account’s opening balance for the statement period.

closingBalance

number

Financial Account’s closing balance for the statement period.

statementPath

string

Path where the statement is stored. Used internally by RocketKOR.

statementYearMonth

string

Year and month of the statement. Used internally by RocketKOR.

year

integer (int32)

Year of the statement.

month

string enum, values: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER

Month of the statement.

monthValue

integer (int32)

Month of the statement as an integer. For example, January is 01.

leapYear

boolean

Whether the statement year is a leap year.

Financial Account Statement Summary Object

				
					{
  "businessAccountId": "string(UUID)",
  "accountHolderId": "string(UUID)",
  "currency": "string",
  "id": "string(UUID)",
  "financialAccountId": "string(UUID)",
  "statementStartDate": "string(date-time)",
  "statementEndDate": "string(date-time)",
  "statementCreatedDate": "string(date-time)",
  "createdBy": "string",
  "createdAt": "string(date-time)",
  "openingBalance": number,
  "closingBalance": number,
  "statementPath": "string",
  "statementYearMonth": {
    "year": integer(int32),
    "month": "string",
    "monthValue": integer(int32),
    "leapYear": boolean
  }
}