Get Accounts

Overview

The getAccounts operation will return a list of accounts for the siteIDList specified.

Request

Element	Type	Description
siteIDList	Array	An optional list of property IDs for which accounts should be returned. If provided, this must be a subset of properties that are enabled for your API. Alternatively, exclude this attribute from the request to get mapping info for every property enabled for your API
afterDate	String	Providing this will filter results to only include accounts modified after this date.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getAccounts",
    "siteIDList": [
        1853
    ],
    "afterDate": "2024-01-01"
}

Response

Element				Type	Description
siteList				Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request
	siteID			Integer	The internal siteID of the property in the IBE.
	primaryName			String	Property name.
	accountList			Array	A list of accounts associated with the current siteID.
		accountID		Integer	The internal accountID of the account in the CRM platform.
		parentAccountID		Integer	If the account is a sub account, this will be the internal accountID of the parent account.
		dtCreated		String	The datetime the account was first created.
		dtModified		String	The datetime the account was last modified.
		dtLastLogin		String	The datetime the account holder last logged in to this account.
		username		String	The username associated with this account.
		status		String	The status of the account.
		name		Object	Details of the name of the account holder.
			title	String	Title of the account holder.
			first	String	First name of the account holder.
			last	String	Last name of the account holder.
			email	String	Email address of the account holder.
		address		Object	Details of the address of the account holder.
			line1	String	Line 1 of the account holders address.
			line2	String	Line 2 of the account holders address.
			town	String	Town of the account holders address.
			zip	String	Post code of the account holders address.
			county	String	County of the account holders address.
			country	String	Country of the account holders address.
		companyName		String	The company name associated with the account holder.
		phone		Object	Details of the phone number of the account holder.
			number1	String	The primary phone number of the account holder
			number2	String	The secondary phone number of the account holder
	templateList			Array	A list of account templates configured for this property.
		templateID		String	The internal templateID of this template in the CRM platform.
		dtCreated		String	The datetime this template was first created.
		templateName		String	The name of the template.
		templateNotes		String	Any internal notes configured for the template.
		rateList		Object	Details of the rates associated with this template.
			rates	Array	A list of rates this template will give you access to.
			allowOtherRates	Boolean	An indicator of whether or not other rates are allowed when using this template.
		rateCodePattern		String	A comma separated list of rates this template will give you access to.
		allowPublicRates		String	An indicator of whether or not public rates are accessible on this template.
		templateFlags		Object	Details of flags applied to this template.
			templateFlags	Array	A list of flags associated with this template.
		discountID		String	The internal discountID applied to this template.
	discountList			Array	A list of discounts configured on the CRM platform.
		discountID		String	The internal discountID of the discount in the CRM platform.
		dtCreated			The datetime the discount was first created.
		status			The status of the discount.
		title			The title of the discount.
		description			A description of the discount.
		type		String	The type of discount.
		discountRules		Array	A list of rules that apply to the discount.
			value	String	The discount value to be applied.
			whitelist		The rates this discount will be applied to.
			blacklist		The rates that are excluded from having this discount applied.

Sample

{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "accountList": [
        {
          "accountID": "8796093023815",
          "templateID": "8796093023814",
          "dtCreated": "2024-04-22 12:31:46",
          "dtModified": "2024-04-22 12:31:46",
          "dtLastLogin": null,
          "username": "martin.mahony@shrgroup.com",
          "status": "active",
          "name": {
            "title": "Mr",
            "first": "Martin",
            "last": "Mahony"
          },
          "email": "martin.mahony@shrgroup.com",
          "address": {
            "line1": "12 Doncarrig",
            "line2": "Ballycommon",
            "town": "Nenagh",
            "zip": "E45 FV30",
            "county": "Tipperary",
            "country": "IE"
          },
          "companyName": "SHRGroup",
          "phone": {
            "number1": "0851020429",
            "number2": ""
          }
        },
        {
          "accountID": "8796093023822",
          "templateID": "8796093023814",
          "dtCreated": "2024-05-21 13:39:28",
          "dtModified": "2024-05-21 13:39:28",
          "dtLastLogin": null,
          "username": "joe.blogs@gmail.com",
          "status": "active",
          "name": {
            "title": "Mr",
            "first": "Joe",
            "last": "Bloggs"
          },
          "email": "joe.blogs@gmail.com",
          "address": {
            "line1": "Avvio House, Lonsdale Road",
            "line2": "National Technology Park",
            "town": "Castletroy",
            "zip": "V94 AW2X",
            "county": "Co. Limerick",
            "country": "IE"
          },
          "companyName": "SHR",
          "phone": {
            "number1": "+353 (0)61 335 680",
            "number2": ""
          }
        }
      ],
      "templateList": [
        {
          "templateID": "8796093023814",
          "dtCreated": "2024-04-22 12:07:29",
          "templateName": "TestHotel Mahony Template",
          "templateNotes": "This is a test template",
          "rateList": {
            "rates": [
              4208974,
              4208975
            ],
            "allowOtherRates": true
          },
          "rateCodePattern": "FOO,BAR",
          "allowPublicRates": "no",
          "templateFlags": {
            "templateFlags": [
              "acrequest",
              "vip",
              "remme"
            ]
          },
          "discountID": "8796093023002"
        },
        {
          "templateID": "8796093023816",
          "dtCreated": "2024-04-22 13:44:15",
          "templateName": "Another Template",
          "templateNotes": "This is another template",
          "rateList": {
            "rates": [],
            "allowOtherRates": true
          },
          "rateCodePattern": "",
          "allowPublicRates": "no",
          "templateFlags": {
            "templateFlags": ""
          },
          "discountID": "0"
        }
      ],
      "discountList": [
        {
          "discountID": "8796093023002",
          "dtCreated": "2018-02-15 10:31:20",
          "status": "active",
          "title": "Fixed Amount Off",
          "description": "A fixed amount reduction.",
          "defaultDiscount": null,
          "type": "fixed",
          "discountRules": [
            {
              "value": "15",
              "whitelist": [
                "BARRO"
              ],
              "blacklist": [
                ""
              ]
            }
          ]
        }
      ]
    }
  ]
}