GET api/entitynotes/entity/{id}/entitynotes?includeSuperNotes={includeSuperNotes}

Get all entity notes

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Gl Entity Id	integer	Required
includeSuperNotes		boolean	Required

Body Parameters

None.

Response Information

Resource Description

NoteEntityViewModel

Collection of NoteEntityViewModel

Name	Description	Type	Additional information
Id		integer	None.
IsInherited	Is inherited	boolean	None.
ReferenceId	Reference Id (GL Entity Id)	integer	Required
NoteTitle	Note Title	string	None.
Note	Note	string	Required String length: inclusive between 0 and 500
IsPinned	IsPinned	boolean	None.
EffectiveDate	Effective Date	date	Required
TerminationDate	Termination Date	date	Required
DisplayInRSM	Display In RSM	boolean	None.
NoteType	NoteType	integer	Required Range: inclusive between 1 and 2
Order	Note Order	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "isInherited": true,
    "referenceId": 3,
    "noteTitle": "sample string 4",
    "note": "sample string 5",
    "isPinned": true,
    "effectiveDate": "2025-04-03T18:08:12.5237166-04:00",
    "terminationDate": "2025-04-03T18:08:12.5237166-04:00",
    "displayInRSM": true,
    "noteType": 10,
    "order": 1
  },
  {
    "id": 1,
    "isInherited": true,
    "referenceId": 3,
    "noteTitle": "sample string 4",
    "note": "sample string 5",
    "isPinned": true,
    "effectiveDate": "2025-04-03T18:08:12.5237166-04:00",
    "terminationDate": "2025-04-03T18:08:12.5237166-04:00",
    "displayInRSM": true,
    "noteType": 10,
    "order": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfNoteEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <NoteEntityViewModel>
    <DisplayInRSM>true</DisplayInRSM>
    <EffectiveDate>2025-04-03T18:08:12.5237166-04:00</EffectiveDate>
    <IsPinned>true</IsPinned>
    <Note>sample string 5</Note>
    <NoteTitle>sample string 4</NoteTitle>
    <NoteType>10</NoteType>
    <Order>1</Order>
    <TerminationDate>2025-04-03T18:08:12.5237166-04:00</TerminationDate>
    <ReferenceId>3</ReferenceId>
    <Id>1</Id>
    <IsInherited>true</IsInherited>
  </NoteEntityViewModel>
  <NoteEntityViewModel>
    <DisplayInRSM>true</DisplayInRSM>
    <EffectiveDate>2025-04-03T18:08:12.5237166-04:00</EffectiveDate>
    <IsPinned>true</IsPinned>
    <Note>sample string 5</Note>
    <NoteTitle>sample string 4</NoteTitle>
    <NoteType>10</NoteType>
    <Order>1</Order>
    <TerminationDate>2025-04-03T18:08:12.5237166-04:00</TerminationDate>
    <ReferenceId>3</ReferenceId>
    <Id>1</Id>
    <IsInherited>true</IsInherited>
  </NoteEntityViewModel>
</ArrayOfNoteEntityViewModel>