Account notes
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all account notes of an account, optionally filtered by activity state, account identifiers, specific account note identifiers or other filter parameters. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/accountNotes/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of Chain
. If not specified, the operation returns data for all chains within scope of the Access Token.
AccountNoteIds
array of string
optional, max 1000 items
AccountIds
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
Interval of Account note's last update date and time.
ActivityStates
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
AccountNotes
required
The set of requested account notes.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Id
string
required
Unique identifier of the account note.
AccountId
string
required
Unique identifier of the account.
Content
string
required
The content of the account note.
AccountType
required
Specifying type of associated account.
Classifications
required
Specifying the classifications of the note based on account type.
IsActive
boolean
required
Whether the account note is still active.
CreatorProfile
required
The profile data of the user who created the account note.
UpdaterProfile
required
The profile data of the user who updated the account note.
General
- For Company and Customer
FoodAndBeverage
- Only Customer
FrontOffice
- Only Customer
Reservations
- Only Customer
Housekeeping
- Only Customer
Maintenance
- Only Customer
PreviousStay
- Only Customer
FamilyRelations
- Only Customer
Gifts
- Only Customer
Accounting
- Only Customer
Complaints
- Only Customer
Other
- Only Customer
[PlatformAddress]/api/connector/v1/accountNotes/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
AccountNotes
required, max 1000 items
Account notes to be added.
AccountId
string
required
Content
string
required, max length 1000 characters
The content of the account note.
Classifications
required, max 1 item
Specifying the classifications of the note based on account type.
AccountNotes
required
Added account notes.
Updates information about the specified account notes.
[PlatformAddress]/api/connector/v1/accountNotes/update
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
AccountNoteUpdates
required, max 1000 items
Account notes to be updated.
AccountNoteId
string
required
Unique identifier of the account note.
Content
optional, max length 1000 characters
Content of the account note (or null
if the content should not be updated).
Classifications
required
Classification of the account note.
General
optional
Company and Customer: Boolean value defining the general classification for the account note (or null
if the value should not be updated).
FoodAndBeverage
optional
Customer only: Boolean value defining the food and beverage classification for the account note (or null
if the value should not be updated).
FrontOffice
optional
Customer only: Boolean value defining the front office classification for the account note (or null
if the value should not be updated).
Reservations
optional
Customer only: Boolean value defining the reservations classification for the account note (or null
if the value should not be updated).
Housekeeping
optional
Customer only: Boolean value defining the housekeeping classification for the account note (or null
if the value should not be updated).
Maintenance
optional
Customer only: Boolean value defining the maintenance classification for the account note (or null
if the value should not be updated).
PreviousStay
optional
Customer only: Boolean value defining the previous stay classification for the account note (or null
if the value should not be updated).
FamilyRelations
optional
Customer only: Boolean value defining the family relations classification for the account note (or null
if the value should not be updated).
Gifts
optional
Customer only: Boolean value defining the gifts classification for the account note (or null
if the value should not be updated).
Accounting
optional
Customer only: Boolean value defining the accounting classification for the account note (or null
if the value should not be updated).
Complaints
optional
Customer only: Boolean value defining the complaints classification for the account note (or null
if the value should not be updated).
Other
optional
Customer only: Boolean value defining the other classification for the account note (or null
if the value should not be updated).
AccountNotes
required
Updated account notes.
Deletes specified account notes.
[PlatformAddress]/api/connector/v1/accountNotes/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
AccountNoteIds
array of string
required, max 1000 items
Unique identifiers of the account notes to be deleted.
Unique identifiers of .
Unique identifiers of the accounts ( or ).
array of
array of
array of
Adds account notes to an account of the enterprise chain. Note this operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
array of
array of
array of
Unique identifier of the chain. Required when using , ignored otherwise.
array of
array of
Unique identifier of the chain. Required when using , ignored otherwise.