GET api/customernote/{id}/{option}

Returns a set of Customer Note records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all note records for Customer where id = customerId, 'ByCustomerNumber' - all note records for Customer where id = CustomerNumber,...

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
option		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerNote

Name	Description	Type	Additional information
CustomerNoteId	Sedona internal autonumber for the Customer Note record	integer	None.
CustomerId	Foreign key from AR_Customer table	integer	None.
Notes	The note	string	Required
UserName	the user who initially added the note; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 25
NoteDate	Date the note was created	date	None.
CustomerSiteId	Foreign key from AR_Customer_Site table, provide if the message references a site record	integer	None.
CustomerSystemId	Foreign key from AR_Customer_System table, provide if the message references a system record	integer	None.
AccessLevel	Allowed values: 1 = viewed by all, including customers, 2 = viewed by office users, 3 = highest level of security; defaults to 2 if not supplied	integer	None.
EditUserCode	the user making this change; defaults to UserCode value from config file if not set explicitly	string	String length: inclusive between 0 and 25
EditDate	Date the note was edited	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerNoteId": 1,
    "CustomerId": 2,
    "Notes": "sample string 3",
    "UserName": "sample string 4",
    "NoteDate": "2025-11-29T14:33:49.8475415-06:00",
    "CustomerSiteId": 1,
    "CustomerSystemId": 1,
    "AccessLevel": 5,
    "EditUserCode": "sample string 6",
    "EditDate": "2025-11-29T14:33:49.8475415-06:00"
  },
  {
    "CustomerNoteId": 1,
    "CustomerId": 2,
    "Notes": "sample string 3",
    "UserName": "sample string 4",
    "NoteDate": "2025-11-29T14:33:49.8475415-06:00",
    "CustomerSiteId": 1,
    "CustomerSystemId": 1,
    "AccessLevel": 5,
    "EditUserCode": "sample string 6",
    "EditDate": "2025-11-29T14:33:49.8475415-06:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CustomerNote>
    <AccessLevel>5</AccessLevel>
    <CustomerId>2</CustomerId>
    <CustomerNoteId>1</CustomerNoteId>
    <CustomerSiteId>1</CustomerSiteId>
    <CustomerSystemId>1</CustomerSystemId>
    <EditDate>2025-11-29T14:33:49.8475415-06:00</EditDate>
    <EditUserCode>sample string 6</EditUserCode>
    <NoteDate>2025-11-29T14:33:49.8475415-06:00</NoteDate>
    <Notes>sample string 3</Notes>
    <UserName>sample string 4</UserName>
  </CustomerNote>
  <CustomerNote>
    <AccessLevel>5</AccessLevel>
    <CustomerId>2</CustomerId>
    <CustomerNoteId>1</CustomerNoteId>
    <CustomerSiteId>1</CustomerSiteId>
    <CustomerSystemId>1</CustomerSystemId>
    <EditDate>2025-11-29T14:33:49.8475415-06:00</EditDate>
    <EditUserCode>sample string 6</EditUserCode>
    <NoteDate>2025-11-29T14:33:49.8475415-06:00</NoteDate>
    <Notes>sample string 3</Notes>
    <UserName>sample string 4</UserName>
  </CustomerNote>
</ArrayOfCustomerNote>