Skip to content

Latest commit

 

History

History
344 lines (299 loc) · 14.5 KB

accountnotes.md

File metadata and controls

344 lines (299 loc) · 14.5 KB

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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainIds": [
    "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "5fcd1933-22f2-40b9-84da-7db04cbecec2"
  ],
  "AccountNoteIds": [
    "3ed9e2f3-4bba-4df6-8d41-ab1b009b6425",
    "8a98965a-7c03-48a1-a28c-ab1b009b53c8"
  ],
  "AccountIds": [
    "a6738390-c241-45b7-8e46-14f47207abe5",
    "435d4d5f-d14f-48dc-a47e-0481fc28ead0"
  ],
  "UpdatedUtc": {
    "StartUtc": "2022-10-10T00:00:00Z",
    "EndUtc": "2022-10-17T00:00:00Z"
  },
  "ActivityStates": [
    "Active"
  ],
  "Limitation": {
    "Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
    "Count": 100
  }
}
Property Type Contract Description
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 Unique identifiers of Account note.
AccountIds array of string optional, max 1000 items Unique identifiers of the accounts (Customer or Company).
UpdatedUtc Time interval optional, max length 3 months Interval of Account note's last update date and time.
ActivityStates array of Activity state optional Whether to return only active, only deleted or both records.
Limitation Limitation required Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "AccountNotes": [
    {
      "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
      "AccountId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
      "Content": "Customer receives a free bottle of champagne during stay",
      "AccountType": "Customer",
      "Classifications": [
        "Gifts"
      ],
      "IsActive": true,
      "CreatorProfile": {
        "Discriminator": "Enterprise",
        "EnterpriseProfile": {
          "ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
        }
      },
      "UpdaterProfile": {
        "Discriminator": "Integration",
        "EnterpriseProfile": null
      }
    },
    {
      "Id": "da34b396-41f7-47f6-8847-aecf00a3f19e",
      "AccountId": "5fcd1933-22f2-40b9-84da-7db04cbecec2",
      "Content": "Lactose intolerant",
      "AccountType": "Customer",
      "Classifications": [
        "FoodAndBeverage"
      ],
      "IsActive": true,
      "CreatorProfile": {
        "Discriminator": "Enterprise",
        "EnterpriseProfile": {
          "ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
        }
      },
      "UpdaterProfile": {
        "Discriminator": "Integration",
        "EnterpriseProfile": null
      }
    }
  ],
  "Cursor": "da34b396-41f7-47f6-8847-aecf00a3f19e"
}
Property Type Contract Description
AccountNotes array of Account note 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.

Account note

Property Type Contract Description
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 Account type required Specifying type of associated account.
Classifications array of Account note classification required Specifying the classifications of the note based on account type.
IsActive boolean required Whether the account note is still active.
CreatorProfile Profile data required The profile data of the user who created the account note.
UpdaterProfile Profile data required The profile data of the user who updated the account note.

Account note classification

  • 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

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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
  "AccountNotes": [
    {
      "AccountId": "8ddea57b-6a5c-4eec-8c4c-24467dce118e",
      "Content": "Brother of the CEO",
      "Classifications": [
        "FamilyRelations"
      ]
    }
  ]
}
Property Type Contract Description
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 Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
AccountNotes array of Account note parameters required, max 1000 items Account notes to be added.

Account note parameters

Property Type Contract Description
AccountId string required
Content string required, max length 1000 characters The content of the account note.
Classifications array of Account note classification required, max 1 item Specifying the classifications of the note based on account type.

Response

{
  "AccountNotes": [
    {
      "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
      "AccountId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
      "Content": "Brother of the CEO",
      "AccountType": "Customer",
      "Classifications": [
        "FamilyRelations"
      ],
      "IsActive": true,
      "CreatorProfile": {
        "Discriminator": "Enterprise",
        "EnterpriseProfile": {
          "ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
        }
      },
      "UpdaterProfile": {
        "Discriminator": "Integration",
        "EnterpriseProfile": null
      }
    }
  ]
}
Property Type Contract Description
AccountNotes array of Account note required Added account notes.

Update account notes

Updates information about the specified account notes.

Request

[PlatformAddress]/api/connector/v1/accountNotes/update

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "AccountNoteUpdates": [
    {
      "AccountNoteId": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
      "Content": {
        "Value": "The AC in the room doesn't work anymore"
      },
      "Classifications": {
        "Maintenance": {
          "Value": true
        },
        "Housekeeping": {
          "Value": false
        }
      }
    }
  ]
}
Property Type Contract Description
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 Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
AccountNoteUpdates array of Account note update parameters required, max 1000 items Account notes to be updated.

Account note update parameters

Property Type Contract Description
AccountNoteId string required Unique identifier of the account note.
Content String update value optional, max length 1000 characters Content of the account note (or null if the content should not be updated).
Classifications Account note update classifications required Classification of the account note.

Account note update classifications

Property Type Contract Description
General Bool update value optional Company and Customer: Boolean value defining the general classification for the account note (or null if the value should not be updated).
FoodAndBeverage Bool update value 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 Bool update value optional Customer only: Boolean value defining the front office classification for the account note (or null if the value should not be updated).
Reservations Bool update value optional Customer only: Boolean value defining the reservations classification for the account note (or null if the value should not be updated).
Housekeeping Bool update value optional Customer only: Boolean value defining the housekeeping classification for the account note (or null if the value should not be updated).
Maintenance Bool update value optional Customer only: Boolean value defining the maintenance classification for the account note (or null if the value should not be updated).
PreviousStay Bool update value optional Customer only: Boolean value defining the previous stay classification for the account note (or null if the value should not be updated).
FamilyRelations Bool update value optional Customer only: Boolean value defining the family relations classification for the account note (or null if the value should not be updated).
Gifts Bool update value optional Customer only: Boolean value defining the gifts classification for the account note (or null if the value should not be updated).
Accounting Bool update value optional Customer only: Boolean value defining the accounting classification for the account note (or null if the value should not be updated).
Complaints Bool update value optional Customer only: Boolean value defining the complaints classification for the account note (or null if the value should not be updated).
Other Bool update value optional Customer only: Boolean value defining the other classification for the account note (or null if the value should not be updated).

Response

{
  "AccountNotes": [
    {
      "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
      "AccountId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
      "Content": "The AC in the room doesn't work anymore",
      "AccountType": "Customer",
      "Classifications": [
        "Maintenance"
      ],
      "IsActive": true,
      "CreatorProfile": {
        "Discriminator": "Enterprise",
        "EnterpriseProfile": {
          "ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
        }
      },
      "UpdaterProfile": {
        "Discriminator": "Integration",
        "EnterpriseProfile": null
      }
    }
  ]
}
Property Type Contract Description
AccountNotes array of Account note required Updated account notes.

Delete account notes

Deletes specified account notes.

Request

[PlatformAddress]/api/connector/v1/accountNotes/delete

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "AccountNoteIds": [
    "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
    "da34b396-41f7-47f6-8847-aecf00a3f19e"
  ]
}
Property Type Contract Description
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 Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
AccountNoteIds array of string required, max 1000 items Unique identifiers of the account notes to be deleted.

Response

{}