Account notes
Get all account notes
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 Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/accountNotes/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of Account note. |
| array of string | optional, max 1000 items | |
| optional, max length 3 months | Interval of Account note last update date and time. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account note | required | The set of requested account notes. |
| 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. |
Account note
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the account note. |
| string | required | Unique identifier of the account. |
| required | required | The content of the account note. |
| string Account type | required | |
| array of string | required | Specifying the classifactions of the note based on account type (Customer note classification, Company note classifications). |
| boolean | required | Whether the account note is still active. |
| required | The profile data of the user who created the account note. | |
| required | The profile data of the user who updated the account note. |
Customer note classifications
General
FoodAndBeverage
FrontOffice
Reservations
Housekeeping
Maintenance
PreviousStay
FamilyRelations
Gifts
Accounting
Complaints
Other
Company note classifications
General
Add account notes
Adds account notes to an account of the enterprise chain. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/accountNotes/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Account note parameters | required, max 1000 items | Account notes to be added. |
Account note parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | |
| string | required, max length 1000 characters | Content of the account note. |
| array of string | required, max length 1 | Classification of the account note based on account type (Customer note classification, Company note classifications). |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account notes | required | Added account notes. |
Update account notes
Updates information about the specified account notes.
Request
[PlatformAddress]/api/connector/v1/accountNotes/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Account note update parameters | required, max 1000 items | Account notes to be updated. |
Account note update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the account note. |
| optional, max length 1000 characters | Content of the account note (or | |
| required | Classification of the account note |
Customer note classifications update parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Boolean value defining the general classification for the account note. (or | |
| optional | Boolean value defining the food and beverage classification for the account note. (or | |
| optional | Boolean value defining the front office classification for the account note. (or | |
| optional | Boolean value defining the reservations classification for the account note. (or | |
| optional | Boolean value defining the housekeeping classification for the account note. (or | |
| optional | Boolean value defining the maintenance classification for the account note. (or | |
| optional | Boolean value defining the previous stay classification for the account note. (or | |
| optional | Boolean value defining the family relations classification for the account note. (or | |
| optional | Boolean value defining the gifts classification for the account note. (or | |
| optional | Boolean value defining the accounting classification for the account note. (or | |
| optional | Boolean value defining the complaints classification for the account note. (or | |
| optional | Boolean value defining the other classification for the account note. (or |
Company note classifications update parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Boolean value defining the general classification for the account note. (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account note | required | Updated account notes. |
Delete account notes
Deletes specified account notes.
Request
[PlatformAddress]/api/connector/v1/accountNotes/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the account notes to be deleted. |
Response
Last updated