RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Note Object

The Note object represents a note attached to a Financial Account, Recipient Account, Team Member, or transaction.

Attributes

id

string (UUID)

Unique ID assigned to the note.

entityId  

string (UUID)

ID of the entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

entityType  

string enum, values: FINANCIAL_ACCOUNT, RECIPIENT, TEAM_MEMBER, TRANSACTION

Type of entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

title

string, max length: 128

Note title.

contentText

string, max length: 1000

Note content.

contentType

string

Reserved for future use.

externalUrl

string

Reserved for future use.

sizeInBytes

integer (int64)

Reserved for future use.

businessAccountId  

string (UUID)

Business Account ID for the user that created the note.

createdBy

object

Entity that created the note.

id

string (UUID)

ID of the entity that created the note.

type

string enum, values: EMPLOYEE, SERVICE_ACCOUNT, RECIPIENT

Type of entity that created the note. Possible values are:

  • EMPLOYEE  Team Member using the RocketKOR Portal.
  • SERVICE_ACCOUNT  Service Account via the RocketKOR APIs.
  • RECIPIENT  Recipient Account.

createdAt

string (date-time)

Date and time the note was created.

updatedBy

object

Entity that last updated the note. This could be a RocketKOR Service Account (if the note was updated via an API) or a Team Member (if the note was updated in the RocketKOR Portal).

id

string (UUID)

ID of the entity that last updated the note.

type

string enum, values: EMPLOYEE, SERVICE_ACCOUNT, RECIPIENT

Type of entity that last updated the note. Possible values are:

  • EMPLOYEE  Team Member using the RocketKOR Portal.
  • SERVICE_ACCOUNT  Service Account using APIs.
  • RECIPIENT  Recipient Account.

updatedAt

string (date-time)

Date and time the note was last updated.

The Note Object

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account.",
  "contentType": "",
  "externalUrl": "",
  "sizeInBytes": 0,
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "updatedAt": "2021-09-20T22:09:31.947Z"
}