NAV Navbar
Logo
JSON

Introduction

The essensys Operate API enables easy integration with other systems to enhance existing capabilities or build custom applications. You can use the dark panel on the right hand side to view example JSON requests and responses.

We have created example starter projects for IOS Swift 3, Android (Java), Android (Kotlin) and PHP.

Example Android Studio 2 (Java) project:

Example Android Studio 3 (Kotlin) project:

Example iOS (Swift 3) project:

Example PHP code:

Records, Queries, Filters

The essensys Operate API can return individual records by appending the id to the endpoint, or can be queried for multiple records conforming to some criteria. The fields returned can be reduced to a defined subset.

Records

Each endpoint can typically access individual records using an id.

For example

https://operate-api.essensys.tech/api/1.0/DraftInvoiceLine/1219

Queries

You can query the API by providing an expression after the endpoint:

For example: return all the Calendars where the resourceid is 2726

https://operate-api.essensys.tech/api/1.0/DraftInvoiceLine?Calendar?where=[resource]=%272726%27

Note: %27 is the URL encoding for ‘

Fields

The response from the API can be reduced to a defined subset of fields by appending a list of fields at the end of the query:

&fields=[field1,field2,...,fieldN]

For example

Return contactname, duration, startdate and enddate for calendar with resource id of 2726.

https://uat.hubcreate.com/api/1.0/Calendar?where=[resource]=%272726%27AND[startdate]%3E=%272016-09-01%27AND[enddate]%3C=%272016-09-30%27&fields=[contactname,duration,startdate,enddate]

Where a GET request returns an Array of one or more items. Included with the fields will be

Field Type Description
row_num int incremented integer for the JSON response starting at 1

HTTP Methods

GET

curl https://operate-api.essensys.tech/api/1.0/account/572467 \
 -H 'Authorization: Bearer gAA...X-w'

Need header: - “Authorization: Bearer nnnnn…” where nnnnn… is access token.

PUT

curl  -X PUT \
 -H 'Authorization: Bearer gAAAAI...q3w' \
 -d data='{"accounts": [{"clientname": "The Client Name","clienttype": "2","enddate": "22/10/2013","startdate": "22/10/2013"}]}' \
 https://operate-api.essensys.tech/api/1.0/account

Need header: - “Authorization: Bearer gAAAAI…q3w” where gAAAAI…q3w is access token.

Need to pass data=‘{…}’ where {…} is the JSON object

DELETE

curl -X DELETE \
 -H "Content-type: application/x-www-form-urlencoded; charset=utf-8" \
 -H "Authorization: Bearer xxxxx" \
 -d "itemid=1" \
 https://operate-api.essensys.tech/api/1.0/brand

Need headers: - “Authorization: Bearer nnnnn…” where nnnnn… is access token. - “Content-type: application/x-www-form-urlencoded; charset=utf-8”

Need to pass data “itemid=NNNN” where NNNN is the identifier

Datatypes

Overview

All datatypes are wrapped in strings in the JSON response / JSON body, for example from Account “billday”: “3”

The following types are defined in addition to string to help describe the contents of those strings:

Type Description
boolean true or false
int Integer can be positive or negative whole number.
currency value including the currency symbol e.g. £33.50
date date and time ISO 8601 see Dates below for more information
decimal a value with decimal places.
object contains a JSON object with its fields and datatypes.
percent number followed by %
time hh:mm

Dates

ISO 8601 combined date and time with UTC offset.

Queries can use certain abbreviations of full date and time strings.

For example:

[creationdate]>=‘2017’

[creationdate]>=‘2017-05-01’

Authentication

Access and Refresh Tokens:

curl -H 'application/x-www-form-urlencoded; charset=utf-8' \
     -X POST \
     -d 'grant_type=password&client_id=trustedclient&client_secret=8bf2d32e-dddd-yyyy-xxxx-38c2fc413858&scope=hubapi&username=nnnnnnnn@domain.com&password=password' \
     https://operate-api.essensys.tech/oauth2/token 

Access and Refresh Token extracted from JSON response (note tokens trunked below)

{
  "access_token":"QFrMNc34O4.....4O4F",
  "token_type":"bearer",
  "expires_in":120,
  "refresh_token":"D1xGAAA....0ENHB_1kZ0EN",
  "scope":"hubapi"
}

essensys Operate uses the OAuth 2.0 protocol for authentication and authorization. To start making calls to the API you can follow the steps below:

Please contact support@essensys.tech to arrange this.

This is done by passing the client_secret from the App registration to:

https://operate-api.essensys.tech/oauth2/token

Note: Add header for the content type for the call:

'Content Type: application/x-www-form-urlencoded; charset=utf-8'

'Authorization: Bearer gAA...X-w'

Accounts

Account

https://operate-api.essensys.tech/api/1.0/account/

Accounts represent business entities. There are three types of Account records: Prospect, Customer or Broker.

Account is the key endpoint for creating, modifying and deleting a Prospect, Customer or Broker.

An Account has an Account Type default value for Account Type is -1 Customer.

Group Account is used to organize Accounts that belong to the same customer, who use different locations.

Account Code, Account Fixed Exchange Rate, Activity History, Batch Charge Sheet, Booking Charge, Booking Conflict, Calendar, Current Charge, Draft Invoice, Email Group, Group Account, Invoice Line, Journals, Licence, Metered Batch Charge Sheet, Note, Open Task, Opportunity, Payment, Standard Discount, Task, Tour, Transaction and Volume Discount can reference accountid

GET https://operate-api.essensys.tech/api/1.0/account/572467

curl https://operate-api.essensys.tech/api/1.0/Account/572467 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "b60ba154-4269-4292-bbbb-ad75f21974da",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "06/07/2017 16:02:02",
        "accounts": [
            {
                "row_num": "1",
                "clientname": "Test2",
                "outputvalue_clientname": "Test2",
                "accounttype_id": "-1",
                "outputvalue_accounttype_id": "Customer",
                "accountid": "572467",
                "outputvalue_accountid": "572467",
                "balance": "0.0000",
                "outputvalue_balance": "0.0000",
                "broker": "0",
                "agentcontact": "0",
                "brokerfirstname": null,
                "outputvalue_brokerfirstname": null,
                "brokerlastname": null,
                "outputvalue_brokerlastname": null,
                "campaign_id": "0",
                "chargevat": "true",
                "outputvalue_chargevat": "true",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "companylogourl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_companylogourl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-06T14:20:03+00:00",
                "outputvalue_creationdate": "2017-07-06T14:20:03+00:00",
                "earliesttransactiondateallowed": "1899-12-31T00:00:00+00:00",
                "outputvalue_earliesttransactiondateallowed": "1899-12-31T00:00:00+00:00",
                "emailinvoice": "true",
                "outputvalue_emailinvoice": "true",
                "enddate": "2017-06-22T00:00:00+00:00",
                "outputvalue_enddate": "2017-06-22T00:00:00+00:00",
                "fulladdress": null,
                "outputvalue_fulladdress": null,
                "hasactivelicence": "0",
                "outputvalue_hasactivelicence": "0",
                "includebfwd": "false",
                "outputvalue_includebfwd": "false",
                "showcalldetails": "false",
                "outputvalue_showcalldetails": "false",
                "includeitemisedbill": "true",
                "outputvalue_includeitemisedbill": "true",
                "includestatement": "false",
                "outputvalue_includestatement": "false",
                "isexternal": "false",
                "outputvalue_isexternal": "false",
                "isresidential": "true",
                "outputvalue_isresidential": "true",
                "isvirtual": "false",
                "outputvalue_isvirtual": "false",
                "leaddadiagent": "false",
                "outputvalue_leaddadiagent": "false",
                "leaddadiid": "595fb39d-8478-42cb-89e8-a926178df779",
                "outputvalue_leaddadiid": "595fb39d-8478-42cb-89e8-a926178df779",
                "location": "0",
                "meetingpackageid": "0",
                "onaccount": "false",
                "outputvalue_onaccount": "false",
                "onlinebill": "0",
                "outputvalue_onlinebill": "0",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "overridediscount": "0",
                "outputvalue_overridediscount": "0%",
                "user_id": "0",
                "printinvoice": "false",
                "outputvalue_printinvoice": "false",
                "recordtype": "1",
                "outputvalue_recordtype": "Account",
                "registeredaddresssingleline": null,
                "outputvalue_registeredaddresssingleline": null,
                "registeredfulladdress": null,
                "outputvalue_registeredfulladdress": null,
                "singlelineaddress": null,
                "outputvalue_singlelineaddress": null,
                "startdate": "2017-10-22T00:00:00+00:00",
                "outputvalue_startdate": "2017-10-22T00:00:00+00:00",
                "updatedate": "2017-07-06T14:25:44+00:00",
                "outputvalue_updatedate": "2017-07-06T14:25:44+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "accounts": [
        {
            "clientname": "",
            "accounttype_id": "Item from list",
            "clienttype": "Item from list",
            "enddate": "22/10/2013",
            "startdate": "22/10/2013"
        }
    ]
}

PUT (Full) JSON Body

{
    "accounts": [
        {
            "accountalias": "Darren",
            "clientname": "Darren",
            "accounttype_id": "Item from list",
            "accountsid": "",
            "addressline1": "",
            "addressline2": "",
            "addressline3": "",
            "agenttype": "Item from list",
            "bankaccountname": "",
            "accno": "",
            "bankcode": "",
            "billday": "Selected item",
            "broker": "Item from list",
            "agentcontact": "Item from list",
            "agentemail": "darren@domain.com",
            "agentreference": "",
            "campaign_id": "Item from list",
            "chargevat": "True",
            "clienttype": "Item from list",
            "companylogo": "",
            "companyno": "",
            "contact": "",
            "country": "",
            "county": "",
            "creditlimit": "£0.00",
            "ddreference": "Darren ",
            "ddi": "",
            "departmentnumber": "",
            "emailaddress": "darren@domain.com",
            "emailinvoice": "True",
            "enddate": "22/10/2013",
            "faxno": "+44 845 303 1000",
            "firstname": "Darren",
            "forwardaddresscountry": "",
            "forwardaddresscounty": "",
            "forwardaddressfax": "",
            "forwardaddressfirstname": "",
            "forwardaddresslastname": "",
            "forwardaddressline1": "",
            "forwardaddressline2": "",
            "forwardaddressline3": "",
            "forwardaddresspostcode": "",
            "forwardaddresstelephone": "+44 845 303 1000",
            "forwardaddresstown": "Town",
            "freetext": "",
            "groupaccount": "Item from list",
            "includebfwd": "True",
            "showcalldetails": "True",
            "includeitemisedbill": "True",
            "includestatement": "True",
            "industry": "Item from list",
            "invoicebccaddress": "darren@rjmetis.com",
            "invoiceccaddress": "darren@rjmetis.com",
            "invoiceemailaddress": "darren@rjmetis.com",
            "lastname": "Smith",
            "leadsource": "Item from list",
            "leaddadiagent": "True",
            "location": "Item from list",
            "meetingpackageid": "Item from list",
            "mobileno": "07111 211211",
            "bankname": "Bank PLC",
            "onaccount": "True",
            "onlinebill": "True",
            "shopperreference": "",
            "overridediscount": "100%",
            "user_id": "Item from list",
            "paymenttoken": "",
            "postcode": "",
            "printinvoice": "True",
            "registeredaddresscountry": "",
            "registeredaddresscounty": "",
            "registeredaddressline1": "",
            "registeredaddressline2": "",
            "registeredaddressline3": "",
            "registeredaddresspostcode": "",
            "registeredtelephone": "+44 845 303 1000",
            "registeredaddresstown": "",
            "regisiteredfax": "",
            "rentalpaymentterm": "Item from list",
            "rentalpaymenttype": "Item from list",
            "siccode": "",
            "standardpaymentterm": "Item from list",
            "paymenttype": "Item from list",
            "startdate": "22/10/2013",
            "phoneno": "+44 845 303 1000",
            "town": "Town",
            "vatno": "",
            "website": "http://www.spacedadi.com"
        }
    ]
}
curl  -X PUT \
 -H 'Authorization: Bearer gAA...X-w' \
 -d data='{"accounts": [{"clientname": "The Client Name","clienttype": "2","enddate": "22/10/2013","startdate": "22/10/2013"}]}' \
 https://operate-api.essensys.tech/api/1.0/account

DELETE

curl -X DELETE \
 -H "Content-type: application/x-www-form-urlencoded; charset=utf-8" \
 -H "Authorization: Bearer xxxxx" \
 -d "itemid=572467" \
 https://operate-api.essensys.tech/api/1.0/account
Field Type Size Description
accountalias string 255
accountid int Reference to the Account
accounttype_id int accounttypeid from Account Type
addressline1 string 255
addressline2 string 255
addressline3 string 255
agentcontact int contactid from Contact the broker who brought the client.
agentemail string 255
agentreference string 255
agenttype int agenttypeid from Agent Type
balance decimal 18
bankaccountname string 255
bankcode string 255
bankname string
billday int Day of the month 1-31
broker int accountid from Account. The broker through which the account has been acquired.
brokerfirstname string 255
brokerlastname string 255
campaign_id int campaignid from Email Campaign
chargevat boolean
clientname string
clientType int from Client Type
companylogourl string
companyno string 255
contact string 255
country string 255
county string 255
createdby string fullname from User
creationdate date
creditlimit currency The maximum amount of credit extended to a client.
ddi string 20 Direct Debit Instructions
ddreference string 255
departmentnumber string 255 The Department within your Organization that manages the Account.
deposit currency
earliesttransactiondateallowed date When the first transaction can be recorded.
emailaddress string
emailinvoice boolean Account opts to receive invoices via email.
enddate date End date of the business relationship.
faxno string
firstname string 255
forwardaddresscountry string 255
forwardaddresscounty string 255
forwardaddressfax string 255
forwardaddressfirstname string 255
forwardaddresslastname string 255
forwardaddressline1 string 255
forwardaddressline2 string 255
forwardaddressline3 string 255
forwardaddresspostcode string 20
forwardaddresstelephone string 255
forwardaddresstown string 255
freetext string 255
fulladdress string
groupaccount int groupaccountid from Group Account
hasactivelicence boolean
includebfwd boolean
includeitemisedbill boolean Select if the client requires a detailed bill, per item
includestatement boolean
industry int industryid from Industry
invoicebccaddress string
invoiceccaddress string
invoiceemailaddress string
isexternal boolean Account not renting longterm.
isresidential boolean Account occupies an office longterm.
isvirtual boolean Account only uses virtual services.
lastinvoicedate date
leaddadiagent boolean
leaddadiid string
leadsource int leadsourceid from Lead Source
location int locationid from Location. The building where Account is registered.
meetingpackageid int meetingpackageid from Meeting Package
mobileno
onaccount boolean Portal purchases not invoiced immediately, but added to account.
onlinebill boolean Account views invoices on Portal.
organization int organizationid from Organization
overridediscount percent
phoneno string
postcode string 20
printinvoice boolean
recordtype int recordtypeid from Record Type
registeredaddresscountry string 255
registeredaddresscounty string 255
registeredaddressline1 string 255
registeredaddressline2 string 255
registeredaddressline3 string 255
registeredaddresssingleline string
registeredaddresstown string
regisiteredfax string 20
registeredfulladdress string
registeredtelephone string 20
rentalpaymentterm string 255 paymenttermname from Payment Term Represents how much time an Account has between their billing date and Invoice due date for rental related invoices.
rentalpaymenttype string 255 paymenttermname from Payment Type Represents the payment method used for rental services.
shopperreference string 255
showcalldetails boolean
siccode string 255
singlelineaddress string 4000
standardpaymentterm int paymenttermid from Payment Term How much time an Account has between their billing date and Invoice due date for all invoices except rental related.
startdate date Date when business relationship starts.
town string 50
unitnumbers string
updatedate date
updatedby string 255 fullname from User
user_id int userid from User
vatno string 255
website string 255

Account Code

https://operate-api.essensys.tech/api/1.0/accountcode

Account Codes are used to identify the account to charge for Device Imports.

GET https://operate-api.essensys.tech/api/1.0/accountcode/2

curl https://operate-api.essensys.tech/api/1.0/accountcode/2 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "94d2a785-5152-4f83-aaef-fc8866eef5e8",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 13:20:16",
        "accountcodes": [
            {
                "row_num": "1",
                "account": "12",
                "outputvalue_account": "UK Marketing Team",
                "accountcode": "1",
                "outputvalue_accountcode": "1",
                "accountcodeid": "2",
                "outputvalue_accountcodeid": "2",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-08T13:17:00+00:00",
                "outputvalue_creationdate": "2017-08-08T13:17:00+00:00",
                "deviceimport": "1",
                "outputvalue_deviceimport": "Elephant Call Logger",
                "updatedate": "2017-08-08T13:17:00+00:00",
                "outputvalue_updatedate": "2017-08-08T13:17:00+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "accountcodes": [
        {
            "account": "12",
            "accountcode": "1",
            "deviceimport": "1"
        }
    ]
}
Field Type Size Description
account int accountid from Account
accountcode string 255
createdby string 255 fullname from User
creationdate date
deviceimport int deviceimportid from Device Import
recordtype int recordtypeid from Record Type
updatedate date
updatedby string 255 fullname from User

Account Fixed Exchange Rate

https://operate-api.essensys.tech/api/1.0/accountfixedexchangerate

Sets a fixed exchange rate for an Account.

GET https://operate-api.essensys.tech/api/1.0/accountfixedexchangerate/1

curl https://operate-api.essensys.tech/api/1.0/accountfixedexchangerate/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "7284e8f4-25e6-4b81-9e7a-63815516588a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 12:46:25",
        "accountfixedexchangerates": [
            {
                "row_num": "1",
                "account": "12",
                "outputvalue_account": "UK Marketing Team",
                "accountfixedexchangerateid": "1",
                "outputvalue_accountfixedexchangerateid": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-08T12:45:55+00:00",
                "outputvalue_creationdate": "2017-08-08T12:45:55+00:00",
                "currencycode": "1",
                "outputvalue_currencycode": "1",
                "enddate": "2013-10-22T00:00:00+00:00",
                "outputvalue_enddate": "2013-10-22T00:00:00+00:00",
                "exchangerate": "1.1",
                "outputvalue_exchangerate": "1.1",
                "sitecurrency": "GBP",
                "outputvalue_sitecurrency": "GBP",
                "startdate": "2013-10-22T00:00:00+00:00",
                "outputvalue_startdate": "2013-10-22T00:00:00+00:00",
                "updatedate": "2017-08-08T12:45:55+00:00",
                "outputvalue_updatedate": "2017-08-08T12:45:55+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "accountfixedexchangerates": [
        {
            "account": "12",
            "currencycode": "1",
            "enddate": "22/10/2013",
            "exchangerate": "1.1",
            "startdate": "22/10/2013"
        }
    ]
}
Field Type Size Description
account int accountid from Account
accountfixedexchangerateid int Reference to the Account Fixed Exchange Rate
createdby string 255 fullname from User
creationdate date
currencycode int currencyid from Currency
enddate date
exchangerate decimal The exchange rate applied to an account.
sitecurrency string
startdate date
updatedate date
updatedby string 255 fullname from User

Account Type

https://operate-api.essensys.tech/api/1.0/accounttype

Default Account Types are: Prospect, Customer and Broker. Custom types can be created using a new Record Type.

An Account requires a reference to an accounttypeid.

GET https://operate-api.essensys.tech/api/1.0/AccountType/-6

curl https://operate-api.essensys.tech/api/1.0/accounttype/-6 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "4780cb1a-a67e-4f84-9329-375e940691b3",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 10:20:01",
        "accounttypes": [
            {
                "row_num": "1",
                "accounttypename": "Converted Lead",
                "outputvalue_accounttypename": "Converted Lead",
                "accounttypeid": "-6",
                "outputvalue_accounttypeid": "-6",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "creationdate": "2015-08-06T06:26:11+00:00",
                "outputvalue_creationdate": "2015-08-06T06:26:11+00:00",
                "updatedate": "2015-08-06T06:26:11+00:00",
                "outputvalue_updatedate": "2015-08-06T06:26:11+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
accounttypename string
accounttypeid int reference to the Account Type
createdby string 255 fullname from User
creationdate date
updatedate date
updatedby string 255 fullname from User

Group Account

https://operate-api.essensys.tech/api/1.0/groupaccount

Group Accounts are used to organize Accounts that belong to one customer, who may exist across multiple locations.

GET https://operate-api.essensys.tech/api/1.0/groupaccount/1

curl https://operate-api.essensys.tech/api/1.0/groupaccount/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "8decafa8-c898-45ae-8021-4118b4095b93",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "14/08/2017 13:18:15",
        "groupaccounts": [
            {
                "row_num": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-14T13:18:11+00:00",
                "outputvalue_creationdate": "2017-08-14T13:18:11+00:00",
                "groupaccountid": "1",
                "outputvalue_groupaccountid": "1",
                "groupaccountname": "Test Group Account",
                "outputvalue_groupaccountname": "Test Group Account",
                "updatedate": "2017-08-14T13:18:11+00:00",
                "outputvalue_updatedate": "2017-08-14T13:18:11+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum and full) JSON Body

{
    "groupaccounts": [
        {
            "groupaccountid": "",
            "groupaccountname": "Darren"
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
groupaccountid int Reference to the Group Account
groupaccountname string 255
updatedate date
updatedby string 255 fullname from User

Meeting Credit

https://operate-api.essensys.tech/api/1.0/reservationdiscount

Gives clients free hours against meeting rooms/services for a set amount of time.

GET https://operate-api.essensys.tech/api/1.0/ReservationDiscount/1

{
    "response": {
        "id": "95a61f22-2341-4b02-bba4-bf852db960cf",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 13:52:53",
        "reservationdiscounts": [
            {
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-13T13:52:53",
                "outputvalue_creationdate": "2017-07-13T13:52:53",
                "discount": "12345",
                "outputvalue_discount": "12345",
                "validfrom": "2013-10-22T00:00:00",
                "outputvalue_validfrom": "2013-10-22T00:00:00",
                "volume": "12345",
                "outputvalue_volume": "12345",
                "reservationdiscountid": "1",
                "outputvalue_reservationdiscountid": "1",
                "validto": "2013-10-22T00:00:00",
                "outputvalue_validto": "2013-10-22T00:00:00",
                "updatedate": "2017-07-13T13:52:53",
                "outputvalue_updatedate": "2017-07-13T13:52:53",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ]
    }
}

PUT (minimum) JSON Body

{
    "reservationdiscounts": [
        {
            "productgroup_id": "Item from list"
        }
    ]
}

PUT (full) JSON Body

{
    "reservationdiscounts": [
        {
            "accountname": "Item from list",
            "discount": "1,2345",
            "discount_type": "Selected item",
            "validfrom": "22/10/2013",
            "volume": "1,2345",
            "productgroup_id": "Item from list",
            "validto": "22/10/2013"
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
discount Percent discounted from unit price.
validfrom date
volume int
reservationdiscountid int Reference to the reservation discount
validto date
updatedate date
updatedby string 255 fullname from User

Accounts Receivable

Accounts Receivable

Provides a snapshot of the financial situation of your customers’ Accounts (e.g. balance, credit limit).

GET Only

https://operate-api.essensys.tech/api/1.0/accountsreceivable

GET https://operate-api.essensys.tech/api/1.0/AccountsReceivable/7

curl https://operate-api.essensys.tech/api/1.0/AccountsReceivable/7 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "cda93a50-e18f-47fb-b7e3-5dd2abfcf160",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "06/07/2017 13:40:00",
        "accountsreceivables": [
            {
                "row_num": "1",
                "accountsreceivableid": "7",
                "outputvalue_accountsreceivableid": "7",
                "accountsreceivablename": "UK Sales Team",
                "outputvalue_accountsreceivablename": "UK Sales Team",
                "accountsid": "2",
                "outputvalue_accountsid": "2",
                "amountpaid": "0",
                "outputvalue_amountpaid": "0",
                "balance": "0.0000",
                "outputvalue_balance": "0.0000",
                "createdby": "RJMETIS\\smith",
                "outputvalue_createdby": "RJMETIS\\smith",
                "creationdate": "2016-07-01T09:53:53+00:00",
                "outputvalue_creationdate": "2016-07-01T09:53:53+00:00",
                "earliesttransactiondateallowed": "1899-12-31T00:00:00+00:00",
                "outputvalue_earliesttransactiondateallowed": "1899-12-31T00:00:00+00:00",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "telephone": "07764 447 414",
                "outputvalue_telephone": "07764 447 414",
                "updatedate": "2016-07-12T15:54:06+00:00",
                "outputvalue_updatedate": "2016-07-12T15:54:06+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
accountsid int accountsid from Account
accountsreceivableid int reference to the Accounts Receivable item.
accountsreceivablename string
amountpaid currency The amount that the client has paid out of the outstanding balance.
balance decimal
createdby string 255 fullname from User
creationdate date
earliesttransactiondateallowed date
location int locationid from Location
organization int organizationid from Organization
telephone string
updatedate date
updatedby string 255 fullname from User

Accounts Receivable Payment Type

https://operate-api.essensys.tech/api/1.0/accountsreceivablepaymenttype

Stores information on the type of payment made: e.g.: via credit card, direct debit, cash, etc.

GET https://operate-api.essensys.tech/api/1.0/AccountsReceivablePaymentType/5

curl https://operate-api.essensys.tech/api/1.0/AccountsReceivablePaymentType/5 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "e8678f89-5129-4a2c-b458-8c69c58b302a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 16:44:54",
        "accountsreceivablepaymenttypes": [
            {
                "row_num": "1",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "creationdate": "2016-01-23T16:55:38+00:00",
                "outputvalue_creationdate": "2016-01-23T16:55:38+00:00",
                "paymenttype": "Direct Debit",
                "outputvalue_paymenttype": "Direct Debit",
                "paymenttypeid": "5",
                "outputvalue_paymenttypeid": "5",
                "updatedate": "2016-01-23T16:55:38+00:00",
                "outputvalue_updatedate": "2016-01-23T16:55:38+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
paymenttype string 255
paymenttypeid int Reference to the Payment Type.
updatedate date
updatedby string 255 fullname from User

Transaction

https://operate-api.essensys.tech/api/1.0/transaction

A financial record representing a payment made by or to you.

GET https://operate-api.essensys.tech/api/1.0/transaction/1100

{
    "response": {
        "id": "433786a8-595a-41e6-a42b-f4b852d79c42",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 13:32:02",
        "transactions": [
            {
                "row_num": "1",
                "accountname": null,
                "outputvalue_accountname": null,
                "account": "2",
                "accountno": null,
                "outputvalue_accountno": null,
                "amount": "0.0000",
                "outputvalue_amount": "0.0000",
                "bankcode": null,
                "outputvalue_bankcode": null,
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-03T09:49:46+00:00",
                "outputvalue_creationdate": "2017-08-03T09:49:46+00:00",
                "credit": "0.0000",
                "outputvalue_credit": "0.0000",
                "date": "2013-10-22T00:00:00+00:00",
                "outputvalue_date": "2013-10-22T00:00:00+00:00",
                "ddagreed": "0",
                "outputvalue_ddagreed": "0",
                "ddreference": null,
                "outputvalue_ddreference": null,
                "debit": "0.0000",
                "outputvalue_debit": "0.0000",
                "bacsexported": "0",
                "outputvalue_bacsexported": "0",
                "finalddamount": "0.0000",
                "outputvalue_finalddamount": "0.0000",
                "gross": "0",
                "outputvalue_gross": "0",
                "includeinbacsexport": "false",
                "outputvalue_includeinbacsexport": "false",
                "net": "0",
                "outputvalue_net": "0",
                "outstanding": "0.0000",
                "outputvalue_outstanding": "0.0000",
                "paymenttype": "1",
                "outputvalue_paymenttype": "Cheque",
                "paymenttypename": "Cheque",
                "outputvalue_paymenttypename": "Cheque",
                "invoicenumber": "Test",
                "outputvalue_invoicenumber": "Test",
                "reference": "Test",
                "outputvalue_reference": "Test",
                "status": "4",
                "outputvalue_status": "4",
                "tax": "0",
                "outputvalue_tax": "0",
                "transactionname": "Payment Received",
                "outputvalue_transactionname": "Payment Received",
                "transactionid": "1100",
                "outputvalue_transactionid": "1100",
                "updatedate": "2017-08-03T09:49:46+00:00",
                "outputvalue_updatedate": "2017-08-03T09:49:46+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
account int accountid from Account
accountname string 255
accountno string 255
amount decimal
bacsexported boolean
bankcode string 255
createdby string 255 fullname from User
creationdate date
credit decimal
date date
ddagreed boolean
ddreference string 255
debit decimal
finalddamount decimal
gross
includeinbacsexport boolean
invoicenumber string 255
outstanding decimal
paymenttype int paymenttypeid from Payment Type
reference string 255
status int 4 = Unbooked, 5 = Booked
tax int taxid from Tax
transactionid int Reference to the Transaction
transactionname string 255
updatedate date
updatedby string 255 fullname from User

Bookings

Meeting room bookings are found using the Calendar endpoint.

Calendar belongs to a resource Product, which in turn belongs to a Location.

Each booking needs to be associated with an Account.

Bookings can be confirmed or provisional and they can be updated, cancelled or deleted. Each booking can be accompanied by a Booking Form and/or an Invoice. If an Invoice is not generated, bookings will produce Charge Sheet.

Calendar

https://operate-api.essensys.tech/api/1.0/calendar

Key endpoint for creating, modifying and deleting bookings.

Booking Charge and Booking Conflict can reference a bookingid.

GET https://operate-api.essensys.tech/api/1.0/calendar/629

curl https://operate-api.essensys.tech/api/1.0/calendar/629 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "411cb25f-7556-472f-b88b-fafb57eb887b",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 11:18:22",
        "calendars": [
            {
                "row_num": "1",
                "account": "62",
                "outputvalue_account": "essensys",
                "accountname": "essensys",
                "outputvalue_accountname": "essensys",
                "bookedby": "Ben Smith",
                "outputvalue_bookedby": "Ben Smith",
                "bookingtitle": "Ben Smith ",
                "outputvalue_bookingtitle": "Ben Smith ",
                "bookingid": "629",
                "outputvalue_bookingid": "629",
                "cateringfacilities": null,
                "outputvalue_cateringfacilities": null,
                "clearancetime": "0",
                "outputvalue_clearancetime": "0",
                "contact": "79",
                "outputvalue_contact": "Ben Smith",
                "contactemail": "ben.smith@essensys.tech",
                "outputvalue_contactemail": "ben.smith@essensys.tech",
                "contactname": "Ben Smith",
                "outputvalue_contactname": "Ben Smith",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-19T14:08:36+00:00",
                "outputvalue_creationdate": "2016-10-19T14:08:36+00:00",
                "datebooked": "2016-10-19T14:08:36+00:00",
                "outputvalue_datebooked": "2016-10-19T14:08:36+00:00",
                "discountpercent": "0",
                "outputvalue_discountpercent": "0",
                "discounthours": null,
                "outputvalue_discounthours": null,
                "duration": "0.5 Hrs",
                "outputvalue_duration": "0.5 Hrs",
                "durationhours": "0.5",
                "outputvalue_durationhours": "0.5",
                "enddate": "2016-10-21T11:30:00+00:00",
                "outputvalue_enddate": "2016-10-21T11:30:00+00:00",
                "end_date": "2016-10-21T11:30:00+00:00",
                "outputvalue_end_date": "2016-10-21T11:30:00+00:00",
                "id": "629",
                "outputvalue_id": "629",
                "invoiced": "false",
                "outputvalue_invoiced": "false",
                "unit_id": "150",
                "outputvalue_unit_id": "150",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "locationname": "Aldgate Tower",
                "outputvalue_locationname": "Aldgate Tower",
                "multiplebooking": "false",
                "outputvalue_multiplebooking": "false",
                "notes": null,
                "outputvalue_notes": null,
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "outlookappointmentid": "AQMkADRlYzcyNmRmLTM3MjQtNGU4Mi05MDY0LTFhM2E2MjkyZGYxZgBGAAAD7FSYOKOH-U6JNUXQuRqn0AcAXIYGgYzJq0eXtP86IL0yUQAAAgENAAAAXIYGgYzJq0eXtP86IL0yUQABgsjlGgAAAA==",
                "outputvalue_outlookappointmentid": "AQMkADRlYzcyNmRmLTM3MjQtNGU4Mi05MDY0LTFhM2E2MjkyZGYxZgBGAAAD7FSYOKOH-U6JNUXQuRqn0AcAXIYGgYzJq0eXtP86IL0yUQAAAgENAAAAXIYGgYzJq0eXtP86IL0yUQABgsjlGgAAAA==",
                "priceoverridden": "false",
                "outputvalue_priceoverridden": "false",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "recurringbooking": "false",
                "outputvalue_recurringbooking": "false",
                "relatedspaceproducts": null,
                "outputvalue_relatedspaceproducts": null,
                "resource": "150",
                "outputvalue_resource": "Round Table Room",
                "resourcename": "Round Table Room",
                "outputvalue_resourcename": "Round Table Room",
                "startdate": "2016-10-21T11:00:00+00:00",
                "outputvalue_startdate": "2016-10-21T11:00:00+00:00",
                "start_date": "2016-10-21T11:00:00+00:00",
                "outputvalue_start_date": "2016-10-21T11:00:00+00:00",
                "statusname": "1",
                "outputvalue_statusname": "1",
                "text": "Ben Smith ",
                "outputvalue_text": "Ben Smith ",
                "updatedate": "2016-10-19T14:08:36+00:00",
                "outputvalue_updatedate": "2016-10-19T14:08:36+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith",
                "webbooking": "false",
                "outputvalue_webbooking": "false"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "calendars": [
        {
            "bookingtitle": "",
            "webbooking": "True"
        }
    ]
}

PUT (Full) JSON Body

{
    "calendars": [
        {
            "account": "Item from list",
            "bookedby": "Darren Smith",
            "bookingcolor": "1,2345",
            "bookingtitle": "Darren Smith",
            "cateringresource": "Item from list",
            "contact": "Item from list",
            "datebooked": "22/10/2013 12:23",
            "delegaterate": "Item from list",
            "discountpercentapplied": "1,2345",
            "enddate": "22/10/2013 12:23",
            "invoiced": "True",
            "leadsource": "Darren Smith",
            "location": "Item from list",
            "multiplebooking": "True",
            "discounthoursapplied": "1,2345",
            "notes": "This is very long text which can go over multiple lines",
            "originalbookingid": "1,2345",
            "outlookappointmentid": "Darren Smith",
            "priceoverridden": "True",
            "recurringbooking": "True",
            "reservationdiscount": "1,2345",
            "resource": "Item from list",
            "startdate": "22/10/2013 12:23",
            "statusname": "Selected item",
            "webbooking": "True"
        }
    ]
}
Field Type Size Description
account int accountid from Account
accountname string
bookedby string
bookingtitle string
bookingid int Reference to the Calendar.
cateringfacilities string 32767
clearancetime int
contact int contactid from Contact
contactemail string
contactname string fullname from Contact
createdby string 255 fullname from User
creationdate date
datebooked date
discountpercent percent
discounthours Amount of hours with a discounted price.
duration string
durationhours
enddate date
end_date date
id int Reference to the Calendar. (same as bookingid)
invoiced boolean
unit_id
location int locationid from Locaton
locationname string
multiplebooking boolean
notes string 4000
organization int organizationid from Organization
outlookappointmentid string
priceoverridden boolean
productgroup int productgroupid from Product Group
recurringbooking boolean
relatedspaceproducts string 4000
resource int productid from Product
resourcename string 255
startdate date
start_date date
statusname int 1 = Confirmed, 2 = Provisional, 3 = Unassigned, 4 = Cancelled
text string 255
updatedate date
updatedby string 255 fullname from User
webbooking boolean

Booking Charge

https://operate-api.essensys.tech/api/1.0/BookingCharge

A Booking Charge is added via a Charge Sheet. When invoiced, the Charge Sheet will be added as an Invoice Line.

Note: the identifier is the chargesheetid

GET https://operate-api.essensys.tech/api/1.0/BookingCharge/1274

curl https://operate-api.essensys.tech/api/1.0/BookingCharge/1274 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "548dc240-7c42-4f1e-a821-fd93cb32775a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 16:01:20",
        "bookingcharges": [
            {
                "row_num": "1",
                "accountname": "62",
                "outputvalue_accountname": "essensys",
                "booking": "1275",
                "outputvalue_booking": "Sam Carter ",
                "chargesheetid": "1274",
                "outputvalue_chargesheetid": "1274",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-20T16:58:44+00:00",
                "outputvalue_creationdate": "2016-10-20T16:58:44+00:00",
                "delegatecharge": "false",
                "outputvalue_delegatecharge": "false",
                "datefrom": "2016-10-20T18:00:00+00:00",
                "outputvalue_datefrom": "2016-10-20T18:00:00+00:00",
                "locationname": "1",
                "outputvalue_locationname": "Aldgate Tower",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "product": "145",
                "outputvalue_product": "Boardroom",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": null,
                "outputvalue_referencetext": null,
                "tax": "2",
                "outputvalue_tax": "0.175",
                "dateto": "2016-10-20T19:00:00+00:00",
                "outputvalue_dateto": "2016-10-20T19:00:00+00:00",
                "totalprice": "0",
                "outputvalue_totalprice": "0",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2016-10-20T16:58:44+00:00",
                "outputvalue_updatedate": "2016-10-20T16:58:44+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "bookingcharges": [
        {
            "accountname": "",
            "booking": "",
            "datefrom": "22/10/2013 12:23",
            "product": "",
            "quantity": "1,2345",
            "tax": "",
            "dateto": "22/10/2013 12:23",
            "unitprice": "£0.00"
        }
    ]
}

PUT (Full) JSON Body

{
    "bookingcharges": [
        {
            "accountname": "",
            "booking": "",
            "bundledproduct": "",
            "delegatecharge": "True",
            "datefrom": "22/10/2013 12:23",
            "product": "",
            "quantity": "1,2345",
            "referencetext": "Darren Smith",
            "tax": "",
            "dateto": "22/10/2013 12:23",
            "unitprice": "£0.00"
        }
    ]
}

The following are returned on a GET request. (Note excluding _outputvalue pairs).

Field Type Size Description
accountname int accountid from Account
booking int bookingid from Calendar
chargesheetid int reference for the booking charge
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
delegatecharge boolean
datefrom date
locationname int locationid from Location
location int locationid from Location
markup string
markuptype int 1 = % , 2 = Currency Amount
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext string 255 Displayed on the Booking Charge itself and on the Invoice. Can be null.
tax int taxid from Tax
dateto date
totalprice currency
unitprice currency
updatedate date
updatedby string 255 fullname from User

Booking Conflict

GET first 10 records, listed by oldest first.

https://operate-api.essensys.tech/api/1.0/bookingconflict?startrecord=1&endrecord=10

GET first 10 records since a specified date, listed by oldest first.

https://operate-api.essensys.tech/api/1.0/BookingConflict?startrecord=1&endrecord=10&where=[startdate]>='2017-01-01'

GET https://operate-api.essensys.tech/api/1.0/bookingconflict/

{
    "response": {
        "id": "40be0290-5bf7-4ba7-9db1-b0f6431252b2",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 08:27:33",
        "bookingconflicts": [
            {
                "row_num": "1",
                "account": "62",
                "outputvalue_account": "essensys",
                "accountname": "essensys",
                "outputvalue_accountname": "essensys",
                "bookingtitle": "Ben Smith",
                "outputvalue_bookingtitle": "Ben Smith",
                "bookingid": "629",
                "outputvalue_bookingid": "629",
                "clearancetime": "0",
                "outputvalue_clearancetime": "0",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-19T14:08:36+00:00",
                "outputvalue_creationdate": "2016-10-19T14:08:36+00:00",
                "enddate": "2016-10-21T11:30:00+00:00",
                "outputvalue_enddate": "2016-10-21T11:30:00+00:00",
                "end_date": "2016-10-21T11:30:00+00:00",
                "outputvalue_end_date": "2016-10-21T11:30:00+00:00",
                "id": "629",
                "outputvalue_id": "629",
                "unit_id": "150",
                "outputvalue_unit_id": "150",
                "lead": "62",
                "outputvalue_lead": "essensys",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "locationname": "Aldgate Tower",
                "outputvalue_locationname": "Aldgate Tower",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "resource": "150",
                "outputvalue_resource": "Round Table Room",
                "resourcename": "Round Table Room",
                "outputvalue_resourcename": "Round Table Room",
                "startdate": "2016-10-21T11:00:00+00:00",
                "outputvalue_startdate": "2016-10-21T11:00:00+00:00",
                "start_date": "2016-10-21T11:00:00+00:00",
                "outputvalue_start_date": "2016-10-21T11:00:00+00:00",
                "statusname": "1",
                "outputvalue_statusname": "1",
                "text": "Ben Smith ",
                "outputvalue_text": "Ben Smith ",
                "updatedate": "2016-10-19T14:08:36+00:00",
                "outputvalue_updatedate": "2016-10-19T14:08:36+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith"
            }
        ],
        "totalCount": "1"
    }
}

The following are returned on a GET request. (Note excluding _outputvalue pairs).

Field Type Size Description
account int accountid from Account
accountname string clientname from Account
bookingtitle string bookingtitle from Calendar
bookingid int bookingid from Calendar
clearancetime Time needed to clear the room and prepare for the next booking.
createdby string 255 createdby from Calendar
creationdate date creationdate from Calendar
enddate date enddate from Calendar
end_date date end_date from Calendar
id int id from Calendar
unit_id int unit_id from Calendar
lead int lead from Calendar
location int locationid from Location
locationname string locationname from Location
productgroup int productgroupid from Product Group
resource int resource from Calendar
resourcename string resourcename from Calendar (Typically this is the meeting room name)
startdate date startdate from Calendar
start_date date start_date from Calendar
statusname int 1 = Confirmed, 2 = Provisional, 3 = Unassigned 4 = Cancelled
text string text from Calendar
updatedate date updatedate from Calendar
updatedby string 255 updatedby from Calendar

Cancellation Policy

https://operate-api.essensys.tech/api/1.0/cancellationpolicy

Allows you to choose whether to charge an Account when a Booking is cancelled within a certain timeframe before the actual booking date.

GET https://operate-api.essensys.tech/api/1.0/cancellationpolicy/3

curl https://operate-api.essensys.tech/api/1.0/cancellationpolicy/3 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "250c63ff-bd88-48b2-90e7-3cc53c6bbcc6",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/08/2017 16:06:17",
        "cancellationpolicys": [
            {
                "row_num": "1",
                "cancellationpolicyid": "3",
                "outputvalue_cancellationpolicyid": "3",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-12T16:06:10+00:00",
                "outputvalue_creationdate": "2017-08-12T16:06:10+00:00",
                "noofdays": "10",
                "outputvalue_noofdays": "10",
                "productgroup": "24",
                "outputvalue_productgroup": "Office Rent",
                "updatedate": "2017-08-12T16:06:10+00:00",
                "outputvalue_updatedate": "2017-08-12T16:06:10+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "cancellationpolicys": [
        {
            "clienttype": "1",
            "noofdays": "10",
            "percentagecharge": "10%",
            "percentcharge": "10%",
            "productgroup": "24"
        }
    ]
}

DELETE https://operate-api.essensys.tech/api/1.0/cancellationpolicy

curl -X DELETE \
 -H "Content-type: application/x-www-form-urlencoded; charset=utf-8" \
 -H "Authorization: Bearer gAAAABw..." \
 -d "itemid=3" \
 https://operate-api.essensys.tech/api/1.0/cancellationpolicy
Field Type Size Description
cancellationpolicyid int Reference to the Cancellation Policy
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
noofdays int
percentagecharge percent
productgroup int productgroupid from Product Group
updatedate date
updatedby string 255 fullname from User

Day Delegate Rate

https://operate-api.essensys.tech/api/1.0/daydelegaterate

Day Delegate Rates apply meeting room booking and service charges per person per day.

GET https://operate-api.essensys.tech/api/1.0/daydelegaterate/2

curl https://operate-api.essensys.tech/api/1.0/daydelegaterate/2 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "25d5c0ac-9b63-4aac-a227-7eca3ddbf6a1",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "24/07/2017 16:08:24",
        "daydelegaterates": [
            {
                "row_num": "1",
                "cateringupto": "0.0000",
                "outputvalue_cateringupto": "0.0000",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-24T16:08:18+00:00",
                "outputvalue_creationdate": "2017-07-24T16:08:18+00:00",
                "daydelegateratename": "Day Rate 20",
                "outputvalue_daydelegateratename": "Day Rate 20",
                "daydelegaterateid": "2",
                "outputvalue_daydelegaterateid": "2",
                "facilitiesupto": "0.0000",
                "outputvalue_facilitiesupto": "0.0000",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "minimumdelegates": "12345",
                "outputvalue_minimumdelegates": "12345",
                "updatedate": "2017-07-24T16:08:18+00:00",
                "outputvalue_updatedate": "2017-07-24T16:08:18+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "daydelegaterates": [
        {
            "cateringupto": "£0.00",
            "daydelegateratename": "Day Rate 20",
            "facilitiesupto": "£0.00",
            "location": "1",
            "minimumdelegates": "12",
            "unitprice": "£20.00"
        }
    ]
}
Field Type Size Description
cateringupto decimal
createdby string 255 fullname from User
creationdate date
daydelegateratename string
daydelegaterateid int Reference to the Day Delegate Rate
facilitiesupto decimal
location int locationid from Location
minimumdelegates int
unitprice currency
updatedate date
updatedby string 255 fullname from User

Charges

Adds charges for ad-hoc product or service purchases, generating Batch Sheets, Charge Sheets or Metered Batch Sheets.

Batch Sheets charge multiple customers for products/services within the same Product Group.

Charge Sheets add one charge, per customer, per product/service. When invoiced, the Charge Sheet will be added as an Invoice Line.

Metered Batch Sheets allow readings to be added, to charge for metered services such as electricity.

Batch Sheet

https://operate-api.essensys.tech/api/1.0/BatchSheet

Batch Sheets charge multiple customers for products/services within the same Product Group.

Metered Batch Sheet can reference a batchsheetid.

GET https://operate-api.essensys.tech/api/1.0/BatchSheet/6815

curl https://operate-api.essensys.tech/api/1.0/BatchSheet/6815 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "14305c38-402d-4290-a78a-656cd4f6fd6d",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 10:06:46",
        "batchsheets": [
            {
                "row_num": "1",
                "actualtotal": "0",
                "outputvalue_actualtotal": "0",
                "approved": "false",
                "outputvalue_approved": "false",
                "batchdate": "2016-10-28T17:08:00+00:00",
                "outputvalue_batchdate": "2016-10-28T17:08:00+00:00",
                "batchsheetid": "6815",
                "outputvalue_batchsheetid": "6815",
                "completed": "false",
                "outputvalue_completed": "false",
                "createdby": "Lisa Martin",
                "outputvalue_createdby": "Lisa Martin",
                "creationdate": "2016-10-28T17:08:21+00:00",
                "outputvalue_creationdate": "2016-10-28T17:08:21+00:00",
                "batchsheetname": "New Batch Sheet",
                "outputvalue_batchsheetname": "New Batch Sheet",
                "estimatedtotal": "0.0000",
                "outputvalue_estimatedtotal": "0.0000",
                "grandtotal": "0",
                "outputvalue_grandtotal": "0",
                "location": "0",
                "productgroup": "0",
                "taxtotal": "0",
                "outputvalue_taxtotal": "0",
                "updatedate": "2016-10-28T17:08:21+00:00",
                "outputvalue_updatedate": "2016-10-28T17:08:21+00:00",
                "updatedby": "Lisa Martin",
                "outputvalue_updatedby": "Lisa Martin",
                "variance": "0",
                "outputvalue_variance": "0"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "batchsheets": [
        {
            "approved": "True",
            "batchdate": "22/10/2013",
            "completed": "True",
            "batchsheetname": "Darren Smith",
            "location": "Item from list",
            "productgroup": "Item from list"
        }
    ]
}

PUT (Full) JSON Body

{
    "batchsheets": [
        {
            "approved": "True",
            "batchdate": "22/10/2013",
            "completed": "True",
            "batchsheetname": "Darren Smith",
            "estimatedtotal": "£0.00",
            "location": "Item from list",
            "productgroup": "Item from list"
        }
    ]
}
Field Type Size Description
actualtotal
approved boolean
batchdate date
batchsheetid int Reference to the Batch Sheet
completed boolean
createdby string 255 fullname from User
creationdate date
batchsheetname string
estimatedtotal decimal
grandtotal
location
productgroup
taxtotal
updatedate date
updatedby string 255 fullname from User
variance

Batch Charge Sheet

https://operate-api.essensys.tech/api/1.0/batchchargesheet

Batch Sheets are a quick way to add ad-hoc product or service charges

GET https://operate-api.essensys.tech/api/1.0/batchchargesheet/1274

curl https://operate-api.essensys.tech/api/1.0/batchchargesheet/1274 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "70c78ce7-c85b-4e12-8135-1ab1f120f876",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 10:13:00",
        "batchchargesheets": [
            {
                "row_num": "4",
                "accountname": "62",
                "outputvalue_accountname": "essensys",
                "batchsheet": "1275",
                "outputvalue_batchsheet": "New Batch",
                "chargesheetid": "1274",
                "outputvalue_chargesheetid": "1274",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-20T16:58:44+00:00",
                "outputvalue_creationdate": "2016-10-20T16:58:44+00:00",
                "datefrom": "2016-10-20T18:00:00+00:00",
                "outputvalue_datefrom": "2016-10-20T18:00:00+00:00",
                "locationname": "1",
                "outputvalue_locationname": "Aldgate Tower",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "product": "145",
                "outputvalue_product": "Boardroom",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "quantity": "2",
                "outputvalue_quantity": "1",
                "referencetext": null,
                "outputvalue_referencetext": null,
                "tax": "2",
                "outputvalue_tax": "0.175",
                "dateto": "2016-10-20T19:00:00+00:00",
                "outputvalue_dateto": "2016-10-20T19:00:00+00:00",
                "totalprice": "10.0",
                "outputvalue_totalprice": "0",
                "unitprice": "5.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2016-10-20T16:58:44+00:00",
                "outputvalue_updatedate": "2016-10-20T16:58:44+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "batchchargesheets": [
        {
            "accountname": "12",
            "batchsheet": "Item from list",
            "datefrom": "22/10/2013 12:23",
            "product": "73",
            "quantity": "1",
            "tax": "5",
            "dateto": "22/10/2013 12:23",
            "unitprice": "5.00"
        }
    ]
}

PUT (Full) JSON Body

{
    "batchchargesheets": [
        {
            "accountname": "Item from list",
            "batchsheet": "Item from list",
            "datefrom": "22/10/2013 12:23",
            "product": "73",
            "quantity": "1.5",
            "referencetext": "",
            "tax": "5",
            "dateto": "22/10/2013 12:23",
            "unitprice": "5.00"
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
batchsheet int
chargesheetid int
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
datefrom date
locationname int locationid from Location
location int locationid from Location
markup string % or currency value
markuptype int 1 = % , 2 = Currency Amount
product int productid from Product
productgroup int productgroupid from Product Group
quantity decimal
referencetext string 255
tax int taxid from Tax
dateto date
totalprice decimal
unitprice decimal
updatedate date
updatedby string 255 fullname from User

Charge Sheet

https://operate-api.essensys.tech/api/1.0/chargesheet

Charge Sheets add one charge, per customer, per product/service. When invoiced, the Charge Sheet will be added as an Invoice Line.

GET https://operate-api.essensys.tech/api/1.0/chargesheet/452326

curl https://operate-api.essensys.tech/api/1.0/chargesheet/452326 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "acd36e9f-8d07-4a77-9d7f-9a046b45ad0a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 11:21:51",
        "chargesheets": [
            {
                "row_num": "1",
                "accountfullname": "Test",
                "outputvalue_accountfullname": "Test",
                "accountname": "277754",
                "outputvalue_accountname": "Test",
                "chargesheetid": "452326",
                "outputvalue_chargesheetid": "452326",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Josephine Smith",
                "outputvalue_createdby": "Josephine Smith",
                "creationdate": "2017-07-07T10:00:55+00:00",
                "outputvalue_creationdate": "2017-07-07T10:00:55+00:00",
                "datefrom": "2017-07-07T11:00:00+00:00",
                "outputvalue_datefrom": "2017-07-07T11:00:00+00:00",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "product": "145",
                "outputvalue_product": "Boardroom",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "tax": "5",
                "outputvalue_tax": "20% Tax rate",
                "dateto": "2017-07-07T11:00:49+00:00",
                "outputvalue_dateto": "2017-07-07T11:00:49+00:00",
                "totalprice": "0",
                "outputvalue_totalprice": "0",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2017-07-07T10:00:55+00:00",
                "outputvalue_updatedate": "2017-07-07T10:00:55+00:00",
                "updatedby": "Josephine Smith",
                "outputvalue_updatedby": "Josephine Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "chargesheets": [
        {
            "accountname": "2",
            "datefrom": "22/7/2017 12:23",
            "product": "73",
            "quantity": "1",
            "tax": "1",
            "dateto": "22/7/2017 12:30",
            "unitprice": "£1.00"
        }
    ]
}

PUT (Full) JSON Body

{
    "chargesheets": [
        {
            "accountname": "2",
            "datefrom": "22/7/2017 12:20",
            "product": "73",
            "quantity": "1",
            "referencetext": "",
            "tax": "1",
            "dateto": "22/7/2017 12:30",
            "unitprice": "£1.00"
        }
    ]
}

DELETE https://operate-api.essensys.tech/api/1.0/chargesheet

curl -X DELETE \
 -H "Content-type: application/x-www-form-urlencoded; charset=utf-8" \
 -H "Authorization: Bearer gAAAABw..." \
 -d "itemid=452326" \
 https://operate-api.essensys.tech/api/1.0/chargesheet
Field Type Size Description
accountfullname string
accountname int
chargesheetid int Reference to the Charge Sheet
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
datefrom date
location int locationid from Location
product int productid from Product
productgroup int productgroupid from Product Group
quantity decimal
tax int taxid from Tax
dateto date
totalprice currency
unitprice currency
updatedby string 255 fullname from User
updatedate date

Current Charge

https://operate-api.essensys.tech/api/1.0/currentcharge

A list of any charges which will be in the next bill run and is read only.

GET https://operate-api.essensys.tech/api/1.0/currentcharge/1019

curl https://operate-api.essensys.tech/api/1.0/currentcharge/1019 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "4d469fb8-f130-42f8-b879-8bccd38abeb5",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "24/07/2017 15:42:21",
        "currentcharges": [
            {
                "row_num": "1",
                "account": "62",
                "outputvalue_account": "essensys",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-20T05:27:06+00:00",
                "outputvalue_creationdate": "2016-10-20T05:27:06+00:00",
                "currentchargeid": "1019",
                "outputvalue_currentchargeid": "1019",
                "loggedby": {
                    "@xml:space": "preserve",
                    "#significant-whitespace": " "
                },
                "outputvalue_loggedby": {
                    "@xml:space": "preserve",
                    "#significant-whitespace": " "
                },
                "net": "0",
                "outputvalue_net": "0",
                "product": "Boardroom",
                "outputvalue_product": "Boardroom",
                "productgroup": "Meeting Rooms",
                "outputvalue_productgroup": "Meeting Rooms",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": null,
                "outputvalue_referencetext": null,
                "startdate": "2016-10-21T09:00:00+00:00",
                "outputvalue_startdate": "2016-10-21T09:00:00+00:00",
                "taxrate": "0.2",
                "outputvalue_taxrate": "0.2%",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2016-10-20T05:27:06+00:00",
                "outputvalue_updatedate": "2016-10-20T05:27:06+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
account int accountid from Account
createdby string 255 fullname from User
creationdate date
currentchargeid int Reference to the Current Charge
loggedby object
net currency
product string 255
productgroup string 255
quantity int
referencetext string 255
startdate date
taxrate decimal
unitprice decimal
updatedby string 255 fullname from User
updatedate date

Device Import

https://operate-api.essensys.tech/api/1.0/deviceimport

Import Charges via .csv files from third party applications or devices.

GET https://operate-api.essensys.tech/api/1.0/deviceimport

curl https://operate-api.essensys.tech/api/1.0/deviceimport \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "1181056f-dfa1-4bca-8eb1-5d2e2d883b09",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/08/2017 09:51:30",
        "deviceimports": [
            {
                "batchno": "12345",
                "outputvalue_batchno": "12345",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-15T09:51:29",
                "outputvalue_creationdate": "2017-08-15T09:51:29",
                "importdate": "2017-01-01T00:00:00",
                "outputvalue_importdate": "2017-01-01T00:00:00",
                "deviceimportname": "123",
                "outputvalue_deviceimportname": "",
                "deviceimportid": "5",
                "outputvalue_deviceimportid": "5",
                "updatedate": "2017-08-15T09:51:29",
                "outputvalue_updatedate": "2017-08-15T09:51:29",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ]
    }
}

PUT (Minimum) JSON Body

{
    "deviceimports": [
        {
            "batchno": "12345",
            "importdate": "01/01/2017",
            "deviceimportname": "123",
        }
    ]
}

PUT (Full) JSON Body

{
    "deviceimports": [
        {
            "batchno": "1,2345",
            "importdate": "22/10/2013",
            "deviceimportname": "Item from list",
            "deviceimportid": "Darren",
            "importdata": "Darren",
            "location": "Item from list",
            "importstatus": "Selected item",
            "user": "Item from list"
        }
    ]
}

PUT Response

{
    "response": {
        "id": "aa8a6b9c-67d2-4679-a855-d5c49a185d61",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 07:54:52",
        "deviceimports": [
            {
                "batchno": "123",
                "outputvalue_batchno": "123",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-25T07:54:52",
                "outputvalue_creationdate": "2017-07-25T07:54:52",
                "importdate": "2017-07-24T00:00:00",
                "outputvalue_importdate": "2017-07-24T00:00:00",
                "deviceimportid": "2",
                "outputvalue_deviceimportid": "2",
                "updatedate": "2017-07-25T07:54:52",
                "outputvalue_updatedate": "2017-07-25T07:54:52",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ]
    }
}
Field Type Size Description
batchno int
createdby string 255 fullname from User
creationdate date
deviceimportname int
deviceimportid int Reference to the Device Import
importdata string 400000
importdate date
location int locationid from Location
importstatus int 0 = Processing, 1 = Nothing Imported, 2=Imported with Errors, 3 = Imported Successfully
updatedate date
updatedby string 255 fullname from User
user

Device Import Map

https://operate-api.essensys.tech/api/1.0/deviceimportmap

A custom map of fields to import from third party applications when using Device Import to add charges to Accounts.

GET https://operate-api.essensys.tech/api/1.0/deviceimportmap/8

curl https://operate-api.essensys.tech/api/1.0/deviceimportmap/8 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "c8902925-d05d-422f-a656-ec298bdd5a4a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 14:41:14",
        "deviceimportmaps": [
            {
                "row_num": "1",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "creationdate": "2009-05-29T09:34:04+00:00",
                "outputvalue_creationdate": "2009-05-29T09:34:04+00:00",
                "deviceimportmapid": "8",
                "outputvalue_deviceimportmapid": "8",
                "devicename": "Teamphone",
                "outputvalue_devicename": "Teamphone",
                "fileext": "CSV",
                "outputvalue_fileext": "CSV",
                "filetype": "0",
                "outputvalue_filetype": "0",
                "ignorezerovalues": "true",
                "outputvalue_ignorezerovalues": "true",
                "clearlastrows": "0",
                "outputvalue_clearlastrows": "0",
                "firstrowfields": "0",
                "outputvalue_firstrowfields": "0",
                "updatedate": "2009-05-29T09:34:04+00:00",
                "outputvalue_updatedate": "2009-05-29T09:34:04+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin",
                "useitemcolumn": "true",
                "outputvalue_useitemcolumn": "true"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum & Full) JSON Body

{
    "deviceimportmaps": [
        {
            "deviceimportmapid": "",
            "devicename": "",
            "fileext": "Selected item",
            "filetype": "Selected item",
            "ignorezerovalues": "True",
            "clearlastrows": "123",
            "firstrowfields": "123",
            "useitemcolumn": "True"
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
deviceimportmapid int Reference to the Device Import Map
devicename string
fileext string
filetype
ignorezerovalues
clearlastrows
firstrowfields
updatedby string fullname from User
updatedate date
useitemcolumn boolean

Metered Batch Sheet

https://operate-api.essensys.tech/api/1.0/meteredbatchsheet

Charge clients for metered services. You can add readings every month and bill each Account for the amount they use.

Batch Sheet is also referenced by batchsheetid.

GET https://operate-api.essensys.tech/api/1.0/meteredbatchsheet/11803

{
    "response": {
        "id": "e2109795-370f-41d1-a370-05df2f2e1448",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/08/2017 09:28:37",
        "meteredbatchsheets": [
            {
                "row_num": "1",
                "actualtotal": "0",
                "outputvalue_actualtotal": "0",
                "approved": "true",
                "outputvalue_approved": "true",
                "batchdate": "2017-10-22T00:00:00+00:00",
                "outputvalue_batchdate": "2017-10-22T00:00:00+00:00",
                "batchsheetid": "11803",
                "outputvalue_batchsheetid": "11803",
                "completed": "true",
                "outputvalue_completed": "true",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-15T09:27:39+00:00",
                "outputvalue_creationdate": "2017-08-15T09:27:39+00:00",
                "batchsheetname": "Test 987",
                "outputvalue_batchsheetname": "Test 987",
                "grandtotal": "0",
                "outputvalue_grandtotal": "0",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "product": "73",
                "outputvalue_product": "Room 1",
                "productgroup": "23",
                "taxtotal": "0",
                "outputvalue_taxtotal": "0",
                "updatedate": "2017-08-15T09:27:39+00:00",
                "outputvalue_updatedate": "2017-08-15T09:27:39+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "meteredbatchsheets": [
        {
            "approved": "True",
            "batchdate": "22/10/2013",
            "completed": "True",
            "batchsheetname": "",
            "location": "1",
            "product": "73",
            "productgroup": "23"
        }
    ]
}

PUT (Full) JSON Body

{
    "meteredbatchsheets": [
        {
            "approved": "True",
            "batchdate": "22/10/2013",
            "completed": "True",
            "batchsheetname": "",
            "estimatedtotal": "£0.00",
            "location": "Item from list",
            "product": "Item from list",
            "productgroup": "Item from list"
        }
    ]
}
Field Type Size Description
actualtotal currency
approved boolean
batchdate date
batchsheetid int Reference to the Metered Batch Sheet
completed boolean
batchsheetname string
estimatedtotal currency
grandtotal currency
location int locationid from Location
product int productid from Product
productgroup int productgroupid from Product Group
taxtotal currency
updatedate date
updatedby string 255 fullname from User

Metered Batch Charge Sheet

https://operate-api.essensys.tech/api/1.0/meteredbatchchargesheet

Note: The id for a Metered Batch Charge Sheet is chargesheetid

GET https://operate-api.essensys.tech/api/1.0/meteredbatchchargesheet/628

{
    "response": {
        "id": "03d897a9-d89a-457f-98b4-b502393957bf",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 12:29:41",
        "meteredbatchchargesheets": [
            {
                "row_num": "1",
                "accountname": "essensys",
                "outputvalue_accountname": "essensys",
                "account": "62",
                "outputvalue_account": "essensys",
                "batchsheet": "629",
                "outputvalue_batchsheet": "New Batch",
                "chargesheetid": "628",
                "outputvalue_chargesheetid": "628",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Darren Smith",
                "outputvalue_createdby": "Darren Smith",
                "creationdate": "2016-10-19T14:08:37+00:00",
                "outputvalue_creationdate": "2016-10-19T14:08:37+00:00",
                "datefrom": "2016-10-21T11:00:00+00:00",
                "outputvalue_datefrom": "2016-10-21T11:00:00+00:00",
                "locationname": "1",
                "outputvalue_locationname": "Aldgate Tower",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "office": "150",
                "outputvalue_office": "Round Table Room",
                "product": "150",
                "outputvalue_product": "Round Table Room",
                "productgroup": "27",
                "outputvalue_productgroup": "Meeting Rooms",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": null,
                "outputvalue_referencetext": null,
                "tax": "2",
                "outputvalue_tax": "0.175",
                "dateto": "2016-10-21T11:30:00+00:00",
                "outputvalue_dateto": "2016-10-21T11:30:00+00:00",
                "totalprice": "0.0000",
                "outputvalue_totalprice": "0.0000",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2016-10-19T14:08:37+00:00",
                "outputvalue_updatedate": "2016-10-19T14:08:37+00:00",
                "updatedby": "Darren Smith",
                "outputvalue_updatedby": "Darren Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "meteredbatchchargesheets": [
        {
            "account": "Item from list",
            "batchsheet": "Item from list",
            "datefrom": "22/10/2013 12:23",
            "newmeterreading": "1,2345",
            "product": "Item from list",
            "office": "Item from list",
            "previousmeterreading": "12345",
            "quantity": "12",
            "tax": "Item from list",
            "dateto": "22/10/2013 12:23",
            "unitprice": "£0.00"
        }
    ]
}

PUT (Full) JSON Body

{
    "meteredbatchchargesheets": [
        {
            "account": "Item from list",
            "batchsheet": "Item from list",
            "datefrom": "22/10/2013 12:23",
            "newmeterreading": "1,2345",
            "product": "Item from list",
            "office": "Item from list",
            "previousmeterreading": "12345",
            "quantity": "12",
            "referencetext": "Darren",
            "tax": "Item from list",
            "dateto": "22/10/2013 12:23",
            "unitprice": "£0.00"
        }
    ]
}
Field Type Size Description
accountname string
account int accountid from Account
batchsheet int
chargesheetid int Reference to the Metered Batch Charge Sheet
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
datefrom date
locationname int locationid from Location
location int locationid from Location
office int productid from Product
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext
tax int taxid from Tax
dateto date
totalprice decimal
unitprice decimal
updatedby string 255 fullname from User
updatedate date

Contacts

Contacts are associated to a Lead or Account. Contacts are end users of the Operate Portal they do not have access to Operate.

A User defines a staff member with access to Operate.

Contact

https://operate-api.essensys.tech/api/1.0/contact

A contact is a person to whom you can communicate through Operate. A Contact can be associated with a Lead or an Account.

Access History, Account, Activity History, Calendar, Extension, Licence, Licence Member, Note, Shout Out, Shout Out Reply, Task, Tour and Tracking Entries can make reference to a contactid

GET https://operate-api.essensys.tech/api/1.0/Contact/230

curl https://operate-api.essensys.tech/api/1.0/Contact/230 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "92f0588c-a5c0-4bb7-b20b-09379859be9f",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "17/07/2017 14:37:48",
        "contacts": [
            {
                "row_num": "1",
                "address_id": "389075",
                "outputvalue_address_id": "M",
                "checkedin": "false",
                "outputvalue_checkedin": "false",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "communityprofileactive": "true",
                "outputvalue_communityprofileactive": "true",
                "companylogourl": "/SPACECONTROL/v2/Themes/Clean/Images/Default/avatar.gif",
                "output_companylogourl": "/SPACECONTROL/v2/Themes/Clean/Images/Default/avatar.gif",
                "fullname": "M M",
                "outputvalue_fullname": "M M",
                "contactid": "230",
                "outputvalue_contactid": "230",
                "createdby": "live",
                "outputvalue_createdby": "live",
                "creationdate": "2017-05-31T11:10:34+00:00",
                "outputvalue_creationdate": "2017-05-31T11:10:34+00:00",
                "emailaddress": "support@.com",
                "outputvalue_emailaddress": "support@.com",
                "optout": "false",
                "outputvalue_optout": "false",
                "firstname": "M",
                "outputvalue_firstname": "M",
                "hasactivelicence": "0",
                "outputvalue_hasactivelicence": "0",
                "privatephoneno": null,
                "outputvalue_privatephoneno": null,
                "contactimageurl": "/SPACECONTROL/v2/Themes/Clean/Images/Default/avatar.gif",
                "output_contactimageurl": "/SPACECONTROL/v2/Themes/Clean/Images/Default/avatar.gif",
                "invitedfromportal": "false",
                "outputvalue_invitedfromportal": "false",
                "lastname": "M",
                "outputvalue_lastname": "M",
                "leadname": "389075",
                "outputvalue_leadname": "M",
                "locationname": "1",
                "outputvalue_locationname": "Aldgate Tower",
                "newsletter": "true",
                "outputvalue_newsletter": "true",
                "numberbeingfollowed": "0",
                "outputvalue_numberbeingfollowed": "0",
                "numberoffollowers": "0",
                "outputvalue_numberoffollowers": "0",
                "password": "",
                "outputvalue_password": "",
                "portalaccesslevel": "0",
                "outputvalue_portalaccesslevel": "0",
                "profilepercentcomplete": "0",
                "outputvalue_profilepercentcomplete": "0%",
                "companyprofileactive": "true",
                "outputvalue_companyprofileactive": "true",
                "receiveshoutoutemails": "true",
                "outputvalue_receiveshoutoutemails": "true",
                "receivestatusupdateemails": "true",
                "outputvalue_receivestatusupdateemails": "true",
                "remaininghours": "0m",
                "outputvalue_remaininghours": "0m",
                "phoneno": null,
                "outputvalue_phoneno": null,
                "title": "Test",
                "outputvalue_title": "Test",
                "updatedate": "2017-05-31T11:10:34+00:00",
                "outputvalue_updatedate": "2017-05-31T11:10:34+00:00",
                "updatedby": "live",
                "outputvalue_updatedby": "live"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum) JSON Body

{
    "contacts": [
        {
            "firstname": "Darren Smith",
            "mobilecellno": "07111 211211"
        }
    ]
}

PUT (full) JSON Body

{
    "contacts": [
        {
            "address_id": "Item from list",
            "assistantsname": "Darren Smith",
            "ud_carregno": "Darren Smith",
            "communityprofileactive": "True",
            "communitystatus": "Selected item",
            "companylogo": "",
            "contacttypeid": "Item from list",
            "department": "Darren Smith",
            "dislikestags": "This is very long text which can go over multiple lines",
            "dateofbirth": "22/10/2013",
            "emailaddress": "darren@domain.com",
            "optout": "True",
            "expertisetags": "This is very long text which can go over multiple lines",
            "ext": "",
            "facebookaccount": "http://www.spacedadi.com",
            "faxno": "+44 845 303 1000",
            "firstname": "Darren Smith",
            "flickraccount": "http://www.spacedadi.com",
            "privatephoneno": "+44 845 303 1000",
            "contactimage": "",
            "importantnote": "This is text area",
            "instagramaccount": "http://www.spacedadi.com",
            "interestingfacts": "This is very long text which can go over multiple lines",
            "invitedfromportal": "True",
            "jobfunction": "Darren Smith",
            "lastloggedin": "22/10/2013 12:23",
            "lastname": "Darren Smith",
            "leadname": "Item from list",
            "likestags": "This is very long text which can go over multiple lines",
            "linkedinaccount": "http://www.spacedadi.com",
            "managersname": "Darren Smith",
            "mobilecellno": "07111 211211",
            "newsletter": "True",
            "opportunityname": "Item from list",
            "user_id": "Item from list",
            "password": "This is encrypted text",
            "pinno": "Darren Smith",
            "pinterestaccount": "http://www.spacedadi.com",
            "portalaccesslevel": "Selected item",
            "profilepercentcomplete": "100%",
            "companyprofileactive": "True",
            "receiveshoutoutemails": "True",
            "receivestatusupdateemails": "True",
            "salutation": "Darren Smith",
            "ud_sendvisitormessage": "True",
            "swipecard": "Darren Smith",
            "socialtags": "This is very long text which can go over multiple lines",
            "phoneno": "+44 845 303 1000",
            "title": "Darren Smith",
            "twitteraccount": "http://www.spacedadi.com",
            "socialwebsites": "This is very long text which can go over multiple lines",
            "whatdoido": "This is very long text which can go over multiple lines",
            "whaticareabout": "This is very long text which can go over multiple lines"
        }
    ]
}
Field Type Size Description
address_id int
checkedin boolean
clienttype int clienttypeid from Client Type
communityprofileactive boolean
companylogourl string
contacttypeid int contacttypeid from Contact Type
contactid int Reference to the Contact
contactimageurl string
createdby string 255 fullname from User
creationdate date
emailaddress string
firstname string
fullname string
hasactivelicence int 0 = false
invitedfromportal boolean
jobfunction string 40
lastname string 40
leadname int
likestags string 4000
locationname int locationid from Location
newsletter boolean
numberbeingfollowed int
numberoffollowers int
optout boolean
password string 50 Encrypted
phoneno string
pinno string
pinterestaccount string
portalaccesslevel int 0 = Basic, 1 = Admin, 2 = Mid
profilepercentcomplete percent
companyprofileactive boolean
receiveshoutoutemails boolean
receivestatusupdateemails boolean
remaininghours Hours remaining from their active access plan, if any
salutation string 255
socialtags string 4000
socialwebsites string 4000
swipecard string 255
title string 20
twitteraccount string
updatedate date
updatedby string fullname from User
user_id int userid from User
whatdoido string 4000
whaticareabout string 4000

Contact Type

https://operate-api.essensys.tech/api/1.0/contacttype

Contact Types may include: Primary, Sales or Billing Contacts

GET https://operate-api.essensys.tech/api/1.0/contacttype/593

curl https://operate-api.essensys.tech/api/1.0/contacttype/593 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "682a7481-3179-4717-a0a4-f6a33b083a12",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 16:25:55",
        "contacttypes": [
            {
                "row_num": "1",
                "contacttypename": "Primary Contact",
                "outputvalue_contacttypename": "Primary Contact",
                "contacttypeid": "593",
                "outputvalue_contacttypeid": "593",
                "creationdate": "2011-01-15T17:25:00+00:00",
                "outputvalue_creationdate": "2011-01-15T17:25:00+00:00",
                "updatedate": "2011-01-15T17:25:00+00:00",
                "outputvalue_updatedate": "2011-01-15T17:25:00+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
contacttypename string
contacttypeid int reference to the contact type
creationdate date
updatedate date

Job Titles

https://operate-api.essensys.tech/api/1.0/lookupjobtitles

GET https://operate-api.essensys.tech/api/1.0/lookupjobtitles/28

{
    "response": {
        "id": "79e1af97-5531-41a5-85d1-3577456126ae",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 11:01:13",
        "lookupjobtitless": [
            {
                "row_num": "1",
                "creationdate": "2009-05-29T09:39:58+00:00",
                "outputvalue_creationdate": "2009-05-29T09:39:58+00:00",
                "jobtitle": "Managing Director",
                "outputvalue_jobtitle": "Managing Director",
                "jobtitlesid": "28",
                "outputvalue_jobtitlesid": "28",
                "updatedate": "2009-05-29T09:39:58+00:00",
                "outputvalue_updatedate": "2009-05-29T09:39:58+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
jobtitle string the job title
jobtitlesid int reference to the Job Title
updatedate date

Credit Notes

A document that provides credit to a customer - either for a billing error or an overcharge. A Credit Note will include the Location and Account for which it is being issued, as well as the Credit Note Reason and Credit Note Type.

A Credit Note Template can be applied to the final document, issued to the customer. All Credit Notes are initially created as a Draft Credit Note. They contain one or more Credit Note Lines.

Draft Credit Note

https://operate-api.essensys.tech/api/1.0/draftcreditnote

A Credit Note not yet approved, to which changes can be made.

GET https://operate-api.essensys.tech/api/1.0/draftcreditnote/1082

curl https://operate-api.essensys.tech/api/1.0/draftcreditnote/1082 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "4aa3b444-6d76-4d9e-b365-f8eb7d2b59f2",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 08:12:38",
        "draftcreditnotes": [
            {
                "row_num": "1",
                "accountname": "347810",
                "outputvalue_accountname": "Josephine Smith",
                "approved": "false",
                "outputvalue_approved": "false",
                "bfwd": "0.0000",
                "outputvalue_bfwd": "0.0000",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "Josephine Smith",
                "outputvalue_createdby": "Josephine Smith",
                "creationdate": "2017-06-26T08:33:36+00:00",
                "outputvalue_creationdate": "2017-06-26T08:33:36+00:00",
                "creditnoteid": "1082",
                "outputvalue_creditnoteid": "1082",
                "creditnotereason": "582",
                "outputvalue_creditnotereason": "Client was overcharged",
                "creditnotestatus": "2",
                "outputvalue_creditnotestatus": "2",
                "status": "2",
                "outputvalue_status": "2",
                "creditnotetemplate": "0",
                "creditnotetype": "584",
                "outputvalue_creditnotetype": "Human Error",
                "emailinvoice": "false",
                "outputvalue_emailinvoice": "false",
                "emailaddress": "support@meetingrooms.com",
                "outputvalue_emailaddress": "support@meetingrooms.com",
                "gross": "-3.6",
                "outputvalue_gross": "-3.6",
                "invoiceemailaddress": "support@meetingrooms.com",
                "outputvalue_invoiceemailaddress": "support@meetingrooms.com",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "net": "-3",
                "outputvalue_net": "-3",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "recordtype": "0",
                "tax": "-0.6",
                "outputvalue_tax": "-0.6",
                "updatedate": "2017-07-06T09:51:29+00:00",
                "outputvalue_updatedate": "2017-07-06T09:51:29+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT minimum JSON body

{
    "draftcreditnotes": [
        {
            "accountname": "",
            "creditnotedate": "22/10/2017",
            "creditnotenumber": "",
            "creditnotetemplate": ""
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
approved boolean
bfwd decimal
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
creditnoteid int Reference to the Draft Credit Note
creditnotereason int creditnotereasonid from Crediut Note Reason
creditnotestatus
creditnotetemplate int
creditnotetype int creditnotetypeid from Credit Note
emailinvoice boolean
emailaddress string
gross decimal
invoiceemailaddress string
location int locationid from Location
net decimal
organization int organizationid from Organization
recordtype int recordtypeid from Record Type
tax decimal
updatedate date
updatedby string 255 fullname from User

Draft Credit Note Line

https://operate-api.essensys.tech/api/1.0/draftcreditnoteline

A credit transaction added to a Draft Credit Note.

GET https://operate-api.essensys.tech/api/1.0/draftcreditnoteline/1248

curl https://operate-api.essensys.tech/api/1.0/draftcreditnoteline/1248 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "a63f4a6c-01bf-439c-bff9-c72709356f07",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 12:58:02",
        "draftcreditnotelines": [
            {
                "row_num": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-08T12:57:16+00:00",
                "outputvalue_creationdate": "2017-08-08T12:57:16+00:00",
                "creditnote": "1082",
                "discountfromlist": "0.0000",
                "outputvalue_discountfromlist": "0.0000",
                "draftcreditnotelineid": "1248",
                "outputvalue_draftcreditnotelineid": "1248",
                "from": "2013-10-22T00:00:00+00:00",
                "outputvalue_from": "2013-10-22T00:00:00+00:00",
                "listprice": "0.0000",
                "outputvalue_listprice": "0.0000",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "order": "1",
                "outputvalue_order": "1",
                "product": "73",
                "outputvalue_product": "Room 1",
                "productgroup": "24",
                "outputvalue_productgroup": "Office Rent",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "taxrate": "0",
                "outputvalue_taxrate": "0%",
                "to": "2013-10-22T00:00:00+00:00",
                "outputvalue_to": "2013-10-22T00:00:00+00:00",
                "updatedate": "2017-08-08T12:57:16+00:00",
                "outputvalue_updatedate": "2017-08-08T12:57:16+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "draftcreditnotelines": [
        {
            "creditnote": "1082",
            "from": "22/10/2013",
            "product": "73",
            "to": "22/10/2013"
        }
    ]
}

PUT (Full) JSON Body

{
    "draftcreditnotelines": [
        {
            "bundledproduct": "Item from list",
            "creditnote": "1082",
            "discountfromlist": "",
            "draftcreditnotelineid": "",
            "from": "22/10/2013",
            "listprice": "5.00",
            "markuptype": "Selected item",
            "product": "73",
            "quantity": "1",
            "referencetext": "",
            "tax": "5",
            "to": "22/10/2013",
            "totalprice": "",
            "unitprice": ""
        }
    ]
}
Field Type Size Description
bundledproduct
createdby string 255 fullname from User
creationdate date
creditnote int creditnoteid from Draft Credit Note
discountfromlist
draftcreditnotelineid int Reference to the Draft Credit Note Line
from date
listprice
markup string % or currency value
markuptype int 1 = % , 2 = Currency Amount
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext
tax int taxid from Tax
taxrate decimal taxrate from Tax
to date
unitprice
updatedate date
updatedby string 255 fullname from User

Credit Note

https://operate-api.essensys.tech/api/1.0/creditnote

GET https://operate-api.essensys.tech/api/1.0/creditnote

PUT (Minimum) JSON Body

{
    "creditnotes": [
        {
            "accountname": "Item from list",
            "creditnotedate": "22/10/2013",
            "creditnotenumber": "Darren Smith",
            "status": "Selected item"
        }
    ]
}

PUT (Full) JSON Body

{
    "creditnotes": [
        {
            "accountname": "Item from list",
            "approved": "True",
            "creditnotecomment": "This is very long text which can go over multiple lines",
            "creditnotedate": "22/10/2013",
            "creditnotenumber": "Darren Smith",
            "creditnotereason": "Item from list",
            "creditnotetext": "Darren Smith",
            "creditnotetype": "Item from list",
            "gross": "£0.00",
            "location": "Item from list",
            "net": "£0.00",
            "status": "Selected item",
            "tax": "£0.00"
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
approved boolean
creditnotecomment string 4000
creditnotedate date
creditnotenumber string 255
creditnotereason int creditnotereasonid from Credit Note Reason
creditnotetext string 255
creditnotetype int creditnotetypeid from Credit Note Type
gross currency
location int locationid from Location
net currency
status
tax currency

Credit Note Line

https://operate-api.essensys.tech/api/1.0/creditnoteline

A row of a Credit Note, representing a credit transaction.

GET https://operate-api.essensys.tech/api/1.0/creditnoteline/19

curl https://operate-api.essensys.tech/api/1.0/creditnoteline/19 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "cbf9dac6-583b-4755-91f8-b766b778a7e6",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 08:21:08",
        "creditnotelines": [
            {
                "row_num": "1",
                "bundledproduct": "0",
                "createdby": "DOMAIN\\mari",
                "outputvalue_createdby": "DOMAIN\\mari",
                "creationdate": "2016-07-01T17:07:33+00:00",
                "outputvalue_creationdate": "2016-07-01T17:07:33+00:00",
                "creditnote": "342",
                "discountfromlist": "500",
                "outputvalue_discountfromlist": "500",
                "creditnotelineid": "19",
                "outputvalue_creditnotelineid": "19",
                "from": "2016-01-01T00:00:00+00:00",
                "outputvalue_from": "2016-01-01T00:00:00+00:00",
                "listprice": "1000",
                "outputvalue_listprice": "1000",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "order": "1",
                "outputvalue_order": "1",
                "product": "74",
                "outputvalue_product": "Room 2",
                "productgroup": "24",
                "outputvalue_productgroup": "Office Rent",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": "<FROM> - <TO>",
                "outputvalue_referencetext": "<FROM> - <TO>",
                "tax": "5",
                "outputvalue_tax": "0.2",
                "taxrate": "0.2",
                "outputvalue_taxrate": "20%",
                "to": "2016-01-31T00:00:00+00:00",
                "outputvalue_to": "2016-01-31T00:00:00+00:00",
                "unitprice": "500",
                "outputvalue_unitprice": "500",
                "updatedate": "2016-07-01T17:07:33+00:00",
                "outputvalue_updatedate": "2016-07-01T17:07:33+00:00",
                "updatedby": "DOMAIN\\mari",
                "outputvalue_updatedby": "DOMAIN\\mari"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
bundledproduct
createdby string 255 fullname from User
creationdate date
creditnote int creditnoteid from Credit Note
creditnotelineid int
discountfromlist
from date
listprice
markup string % or currency value
markuptype int 1 = % , 2 = Currency Amount
order
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext string
tax int taxid from Tax
taxrate decimal taxrate from Tax
to date
unitprice
updatedate date
updatedby string 255 fullname from User

Credit Note Reason

https://operate-api.essensys.tech/api/1.0/lookupcreditnotereason

Why the Credit Note is being issued. Default reasons are: Billing Error or Client was overcharged.

Credit Note and Draft Credit Note both use a creditnotereasonid.

GET https://operate-api.essensys.tech/api/1.0/lookupcreditnotereason/582

curl https://operate-api.essensys.tech/api/1.0/lookupcreditnotereason/582 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "0ec2032e-3f95-4151-b73a-e634e30a9844",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 08:18:27",
        "lookupcreditnotereasons": [
            {
                "row_num": "1",
                "creationdate": "2010-10-01T10:23:17+00:00",
                "outputvalue_creationdate": "2010-10-01T10:23:17+00:00",
                "creditnotereasonname": "Client was overcharged",
                "outputvalue_creditnotereasonname": "Client was overcharged",
                "creditnotereasonid": "582",
                "outputvalue_creditnotereasonid": "582",
                "updatedate": "2010-10-01T10:23:17+00:00",
                "outputvalue_updatedate": "2010-10-01T10:23:17+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
creditnotereasonname string
creditnotereasonid int Reference to the Credit Note Reason
updatedate date

Credit Note Template

https://operate-api.essensys.tech/api/1.0/creditnotetemplate

Customizable template for use with Credit Note.

PUT (minimum) JSON Body

{
    "creditnotetemplates": [
        {
            "templatename": "Darren Smith",
            "templateid": "Darren Smith",
            "mergefield": "Item from list",
            "papersize": "Selected item",
            "termsandconditions": {
                "strong": "html"
            },
            "title": "Darren Smith"
        }
    ]
}

PUT (full) JSON Body

{
    "creditnotetemplates": [
        {
            "marginbottom": "1,2345",
            "templatename": "Darren Smith",
            "templateid": "Darren Smith",
            "marginleft": "1,2345",
            "mergefield": "Item from list",
            "papersize": "Selected item",
            "marginright": "1,2345",
            "templatehtml": {
                "strong": "html"
            },
            "termsandconditions": {
                "strong": "html"
            },
            "title": "Darren Smith",
            "margintop": "1,2345"
        }
    ]
}
Field Type Size Description
marginbottom
marginleft
marginright
margintop
mergefield Pulls customer specific information onto the template.
papersize string A4, US Letter
templatename
templateid
termsandconditions object Adds T&Cs to the template.
title string

Credit Note Type

https://operate-api.essensys.tech/api/1.0/lookupcreditnotetype

Default types are: ‘Human error’ and ‘System error’

Used by Credit Note,

GET https://operate-api.essensys.tech/api/1.0/lookupcreditnotetype/584

curl https://operate-api.essensys.tech/api/1.0/lookupcreditnotetype/584 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "12892444-9a56-4d9e-a39f-dec10958df90",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 09:04:28",
        "lookupcreditnotetypes": [
            {
                "row_num": "1",
                "creationdate": "2010-10-01T10:23:17+00:00",
                "outputvalue_creationdate": "2010-10-01T10:23:17+00:00",
                "creditnotetypename": "Human Error",
                "outputvalue_creditnotetypename": "Human Error",
                "creditnotetypeid": "584",
                "outputvalue_creditnotetypeid": "584",
                "updatedate": "2010-10-01T10:23:17+00:00",
                "outputvalue_updatedate": "2010-10-01T10:23:17+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
creditnotetypename string 255
creditnotetypeid int Reference to the Credit Note Type
updatedate date

Inventory

Items that are being used within your business, but are not necessarily sold as standalone products. For example, furniture.

Inventory Item

https://operate-api.essensys.tech/api/1.0/inventoryitem

An item being used within your business but not sold as a Product

GET https://operate-api.essensys.tech/api/1.0/inventoryitem/1

{
    "response": {
        "id": "8e0765aa-b398-4a04-8309-de0b35d0010e",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/07/2017 10:50:23",
        "inventoryitems": [
            {
                "row_num": "1",
                "availableat": "Aldgate Tower",
                "outputvalue_availableat": "Aldgate Tower",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "creationdate": "2011-01-15T17:44:15+00:00",
                "outputvalue_creationdate": "2011-01-15T17:44:15+00:00",
                "group": "40",
                "outputvalue_group": "Keys & Security Fobs",
                "inventoryid": "1",
                "outputvalue_inventoryid": "1",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "name": "Security Fob",
                "outputvalue_name": "Security Fob",
                "recordtype": "10284",
                "outputvalue_recordtype": "InventoryItem",
                "unitcost": "0.0000",
                "outputvalue_unitcost": "0.0000",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "updatedate": "2011-01-15T17:44:15+00:00",
                "outputvalue_updatedate": "2011-01-15T17:44:15+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin",
                "vendor": null,
                "outputvalue_vendor": null
            }
        ],
        "totalCount": "1"
    }
}

PUT (full) JSON Body

{
    "inventoryitems": [
        {
            "group": "Item from list",
            "inventoryid": "",
            "location": "Item from list",
            "name": ""
        }
    ]
}

PUT (full) JSON Body

{
    "inventoryitems": [
        {
            "availableat": "Select Item 1, Selected Item 2",
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "custom4": "",
            "group": "Item from list",
            "inventoryid": "",
            "leadtime": "",
            "location": "Item from list",
            "manufacturer": "Item from list",
            "name": "",
            "notes": "This is very long text which can go over multiple lines",
            "partnumber": "",
            "reorderlevel": "1,2345",
            "reorderquantity": "1,2345",
            "unitcost": "£0.00",
            "unitprice": "£0.00",
            "vendor": "Item from list"
        }
    ]
}
Field Type Size Description
availableat string locationname from Location,
createdby string 255 fullname from User
creationdate date
group int inventorygroupsid from Inventory Group
inventoryid int reference to the Inventory Item
leadtime
location int locationid from Location
manufacturer int manufacturerid from Manufacturers
name string
notes string 4000 from Note
partnumber string 255
recordtype int recordtypeid from Record Type
reorderlevel
reorderquantity
unitcost decimal
unitprice decimal
updatedate date
updatedby string 255 fullname from User
vendor int vendorsid from Vendors

Inventory Group

https://operate-api.essensys.tech/api/1.0/lookupinventorygroups

A group of Inventory Items. Defaults are: Car Park Permit, Furniture, Keys and Security Fobs

GET https://operate-api.essensys.tech/api/1.0/lookupinventorygroups\40

{
    "response": {
        "id": "9d604250-6972-496f-a46b-c3c9206c29ce",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/07/2017 10:53:13",
        "lookupinventorygroupss": [
            {
                "row_num": "1",
                "creationdate": "2009-05-29T09:41:33+00:00",
                "outputvalue_creationdate": "2009-05-29T09:41:33+00:00",
                "inventorygroup": "Keys & Security Fobs",
                "outputvalue_inventorygroup": "Keys & Security Fobs",
                "inventorygroupsid": "40",
                "outputvalue_inventorygroupsid": "40",
                "updatedate": "2009-05-29T09:41:33+00:00",
                "outputvalue_updatedate": "2009-05-29T09:41:33+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "lookupinventorygroupss": [
        {
            "inventorygroup": "Name of the Group"
        }
    ]
}
Field Type Size Description
creationdate date
inventorygroup string 255
inventorygroupsid int Reference to the Inventory Group
updatedate date

Contact Inventory Item

https://operate-api.essensys.tech/api/1.0/contactinventoryitems

GET https://operate-api.essensys.tech/api/1.0/contactinventoryitems/1

curl https://operate-api.essensys.tech/api/1.0/contactinventoryitems/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "87b2dc1f-cbe2-41c6-86c3-786ebe4ef26b",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 16:55:39",
        "contactinventoryitemss": [
            {
                "contactinventoryitemid": "1",
                "outputvalue_contactinventoryitemid": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-13T16:55:39",
                "outputvalue_creationdate": "2017-07-13T16:55:39",
                "date": "2013-10-22T00:00:00",
                "outputvalue_date": "2013-10-22T00:00:00",
                "quantity": "12345",
                "outputvalue_quantity": "12345",
                "transactiontype": "0",
                "outputvalue_transactiontype": "0",
                "updatedate": "2017-07-13T16:55:39",
                "outputvalue_updatedate": "2017-07-13T16:55:39",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ]
    }
}

PUT (minimum) JSON Body

{
    "contactinventoryitemss": [
        {
            "account": "Item from list",
            "contact": "Item from list",
            "contactinventoryitemid": "Darren Smith",
            "date": "22/10/2013",
            "inventoryitem": "Item from list",
            "quantity": "123",
            "transactiontype": "Selected item"
        }
    ]
}

PUT (full) JSON Body

{
    "contactinventoryitemss": [
        {
            "account": "Item from list",
            "contact": "Item from list",
            "contactinventoryitemid": "Darren Smith",
            "date": "22/10/2013",
            "installdate": "22/10/2013",
            "inventoryitem": "Item from list",
            "notes": "This is very long text which can go over multiple lines",
            "quantity": "123",
            "transactiontype": "Selected item"
        }
    ]
}
Field Type Size Description
contactinventoryitemid int Reference to the contact inventory item
createdby string 255 fullname from User
creationdate date
date date
quantity int
transactiontype int Specifies the status of the Contact Inventory Item. Defaults are: 0 = Ordered, 1 = Received, 2 = Shipped, 3 = Allocated, 4 = Returned
updatedate date
updatedby string 255 fullname from User

Manufacturers

https://operate-api.essensys.tech/api/1.0/lookupmanufacturers

GET https://operate-api.essensys.tech/api/1.0/lookupmanufacturers/641

{
    "response": {
        "id": "df8266b5-5974-40b3-8ebb-9c29ce648c96",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 13:44:17",
        "lookupmanufacturerss": [
            {
                "row_num": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-13T13:44:13+00:00",
                "outputvalue_creationdate": "2017-07-13T13:44:13+00:00",
                "manufacturer": "Darren Smith",
                "outputvalue_manufacturer": "Darren Smith",
                "manufacturersid": "641",
                "outputvalue_manufacturersid": "641",
                "updatedate": "2017-07-13T13:44:13+00:00",
                "outputvalue_updatedate": "2017-07-13T13:44:13+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum and full) JSON Body

{
    "lookupmanufacturerss": [
        {
            "manufacturer": "Darren Smith"
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
manufacturer string
manufacturersid int Reference to the Manufacturer
updatedate date
updatedby string 255 fullname from User

Invoices

Bills customers for purchased products or services. When first creating an invoice, it is a Draft Invoice. It will only become a valid Invoice after approval.

Draft Invoice

A DraftInvoice is an Invoice that has not yet been approved and is subject to changes. A DraftInvoice contains one or more Draft Invoice Lines, the DraftInvoiceLine is a row of a DraftInvoice.

GET https://operate-api.essensys.tech/api/1.0/draftinvoice/374

curl https://operate-api.essensys.tech/api/1.0/draftinvoice/374 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "2c87bc93-2af3-471b-9c26-c2139415bbce",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 10:48:28",
        "draftinvoices": [
            {
                "row_num": "1",
                "accountname": "7",
                "outputvalue_accountname": "UK Sales Team",
                "approved": "false",
                "outputvalue_approved": "false",
                "bfwd": "0.0000",
                "outputvalue_bfwd": "0.0000",
                "clienttype": "1",
                "outputvalue_clienttype": "Residential",
                "createdby": "RJMETIS\\ersan",
                "outputvalue_createdby": "RJMETIS\\ersan",
                "creationdate": "2016-07-12T15:54:06+00:00",
                "outputvalue_creationdate": "2016-07-12T15:54:06+00:00",
                "invoicedescription": "Standard Invoice",
                "outputvalue_invoicedescription": "Standard Invoice",
                "emailinvoices": "true",
                "outputvalue_emailinvoices": "true",
                "emailaddress": "joe.murray@essensys.tech",
                "outputvalue_emailaddress": "joe.murray@essensys.tech",
                "endingbalance": "3144.1",
                "outputvalue_endingbalance": "3144.1",
                "gross": "3144.1",
                "outputvalue_gross": "3144.1",
                "invoiceemailaddress": "joe.murray@essensys.tech",
                "outputvalue_invoiceemailaddress": "joe.murray@essensys.tech",
                "invoicesort": "UK Sales Team",
                "outputvalue_invoicesort": "UK Sales Team",
                "status": "2",
                "outputvalue_status": "2",
                "invoicestatus": "2",
                "outputvalue_invoicestatus": "2",
                "invoiceid": "374",
                "outputvalue_invoiceid": "374",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "net": "2953.42",
                "outputvalue_net": "2953.42",
                "officeorder": "false",
                "outputvalue_officeorder": "false",
                "invoicetype": "1",
                "outputvalue_invoicetype": "1",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "paymentscredits": "0",
                "outputvalue_paymentscredits": "0",
                "tax": "190.68",
                "outputvalue_tax": "190.68",
                "updatedate": "2016-07-12T15:54:06+00:00",
                "outputvalue_updatedate": "2016-07-12T15:54:06+00:00",
                "updatedby": "RJMETIS\\ersan",
                "outputvalue_updatedby": "RJMETIS\\ersan"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum) JSON Body

{
    "draftinvoices": [
        {
            "accountname": "Item from list",
            "invoicedate": "22/10/2013",
            "invoicenumber": "",
            "status": ""
        }
    ]
}

PUT (full) JSON Body

{
    "draftinvoices": [
        {
            "accountname": "Item from list",
            "accountref": "",
            "approved": "True",
            "duedate": "22/10/2013",
            "invoicedate": "22/10/2013",
            "invoicenumber": "",
            "invoicestatus": "2",
            "status": "2",
            "invoicetemplate": "Item from list",
            "invoicetext": "",
            "invoicetext1": "",
            "invoicetext2": "",
            "location": "Item from list",
            "officeorder": "12345",
            "invoicetype": "12345"
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
accountref string 255
approved boolean For a draft invoice this will be false.
bfwd decimal
clienttype int clienttypeid from Client Type
createdby string 255 fullname from User
creationdate date
invoicedescription string 255
emailinvoices boolean
emailaddress string 4000
endingbalance decimal
gross decimal
invoiceemailaddress string
invoicesort string 255
invoicestatus int 3 = Draft, 4 = Final
invoiceid int Reference to the Draft Invoice
invoicetype int
location int locationid from Location
net decimal
officeorder boolean
organization int organizationid from Organization
paymentscredits decimal
status int 3 = Draft, 4 = Final
tax decimal
updatedate date
updatedby string 255 fullname from User

Draft Invoice Line

https://operate-api.essensys.tech/api/1.0/draftinvoiceline

A row of a Draft Invoice, representing a charge. A Charge Sheet becomes a Draft Invoice Line when billed.

GET https://operate-api.essensys.tech/api/1.0/draftinvoiceline/16

curl https://operate-api.essensys.tech/api/1.0/draftinvoiceline/16 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "6e5e22e3-8041-420b-aa41-7f52bb68bd93",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 14:29:19",
        "draftinvoicelines": [
            {
                "row_num": "1",
                "bundledproduct": "0",
                "createdby": "RJMETIS\\mari",
                "outputvalue_createdby": "RJMETIS\\mari",
                "creationdate": "2013-04-12T10:32:59+00:00",
                "outputvalue_creationdate": "2013-04-12T10:32:59+00:00",
                "discountfromlist": "0.0000",
                "outputvalue_discountfromlist": "0.0000",
                "draftinvoicelineid": "16",
                "outputvalue_draftinvoicelineid": "16",
                "from": "2013-04-12T00:00:00+00:00",
                "outputvalue_from": "2013-04-12T00:00:00+00:00",
                "invoice": "340",
                "listprice": "2000",
                "outputvalue_listprice": "2000",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "originalbundle": "0",
                "outputvalue_originalbundle": "0",
                "originallicenceitemschedule": "0",
                "outputvalue_originallicenceitemschedule": "0",
                "product": "64",
                "outputvalue_product": "Deposit",
                "productgroup": "20",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": null,
                "outputvalue_referencetext": null,
                "tax": "5",
                "outputvalue_tax": "0.2",
                "taxrate": "0.2",
                "outputvalue_taxrate": "20%",
                "to": "2013-04-12T00:00:00+00:00",
                "outputvalue_to": "2013-04-12T00:00:00+00:00",
                "unitprice": "2000",
                "outputvalue_unitprice": "2000",
                "updatedate": "2013-04-12T10:32:59+00:00",
                "outputvalue_updatedate": "2013-04-12T10:32:59+00:00",
                "updatedby": "RJMETIS\\mari",
                "outputvalue_updatedby": "RJMETIS\\mari"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum) JSON Body

{
    "invoicelines": [
        {
            "draftinvoicelineid": "",
            "from": "22/10/2013",
            "invoice": "",
            "product": "",
            "to": "22/10/2013"
        }
    ]
}

PUT (full) JSON Body

{
    "invoicelines": [
        {
            "bundledproduct": "Item from list",
            "discountfromlist": "£0.00",
            "draftinvoicelineid": "Darren Smith",
            "from": "22/10/2013",
            "invoice": "Item from list",
            "listprice": "£0.00",
            "markuptype": "",
            "product": "",
            "quantity": "12345",
            "tax": "",
            "to": "22/10/2013",
            "totalprice": "£0.00",
            "unitprice": "£0.00"
        }
    ]
}
Field Type Size Description
bundledproduct int
createdby string 255 fullname from User
creationdate date
discountfromlist currency
draftinvoicelineid int Reference to the Draft Invoice Line
from date
invoice int invoiceid from Draft Invoice
listprice currency
markup string % or currency amount
markuptype int 1 = % , 2 = Currency Amount
originalbundle int
originallicenceitemschedule int
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext string 255
tax int taxid from Tax
taxrate decimal
to date
unitprice currency
updatedate date
updatedby string 255 fullname from User

Invoice

https://operate-api.essensys.tech/api/1.0/invoice

An Invoice is created as a Draft Invoice

Invoice Line, License Proforma Invoice and Tax Summary can reference an invoiceid.

GET https://operate-api.essensys.tech/api/1.0/invoice/

{
    "response": {
        "id": "e29d24e9-d0b2-4a79-abb1-642a03129598",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "03/08/2017 12:21:14",
        "invoices": [
            {
                "row_num": "1",
                "accountname": "15",
                "outputvalue_accountname": "",
                "approved": "true",
                "outputvalue_approved": "true",
                "bfwd": "502",
                "outputvalue_bfwd": "502",
                "clienttype": "1",
                "outputvalue_clienttype": "Resident",
                "createdby": "Nicoleta Smith",
                "outputvalue_createdby": "Nicoleta Smith",
                "creationdate": "2016-11-04T11:10:31+03:00",
                "outputvalue_creationdate": "2016-11-04T11:10:31+03:00",
                "invoicedescription": "Standard Invoice",
                "outputvalue_invoicedescription": "Standard Invoice",
                "duedate": "2017-01-31T00:00:00+03:00",
                "outputvalue_duedate": "2017-01-31T00:00:00+03:00",
                "emailinvoices": "true",
                "outputvalue_emailinvoices": "true",
                "invoiceemailaddress": "Nicoleta.Smith@gmail.com",
                "outputvalue_invoiceemailaddress": "Nicoleta.Smith@gmail.com",
                "emailaddress": null,
                "outputvalue_emailaddress": null,
                "endingbalance": "742",
                "outputvalue_endingbalance": "742",
                "gross": "240",
                "outputvalue_gross": "240",
                "invoicedate": "2017-01-05T00:00:00+03:00",
                "outputvalue_invoicedate": "2017-01-05T00:00:00+03:00",
                "invoicenumber": "08",
                "outputvalue_invoicenumber": "08",
                "invoicetemplate": "6",
                "outputvalue_invoicetemplate": "Default Classic Invoice",
                "invoicetext": null,
                "outputvalue_invoicetext": null,
                "invoicetext1": null,
                "outputvalue_invoicetext1": null,
                "invoiceid": "403",
                "outputvalue_invoiceid": "403",
                "location": "1",
                "outputvalue_location": "Chelsea Towers",
                "net": "200",
                "outputvalue_net": "200",
                "organization": "1",
                "outputvalue_organization": "",
                "paid": "false",
                "outputvalue_paid": "false",
                "paymentscredits": "0",
                "outputvalue_paymentscredits": "0",
                "recordtype": "0",
                "status": "5",
                "outputvalue_status": "5",
                "tax": "40",
                "outputvalue_tax": "40",
                "updatedate": "2017-05-26T14:49:59+03:00",
                "outputvalue_updatedate": "2017-05-26T14:49:59+03:00",
                "updatedby": "Christine Smith",
                "outputvalue_updatedby": "Christine Smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
accountname
bfwd currency localized format e.g. £0.00
datepaid date
gross currency localized format e.g. £0.00
invoicedate date
invoicenumber automatically and consecutively allocated to invoices
location int locationid from Location
net currency localized format e.g. £0.00
paid boolean
status
transactionreference

Invoice Line

https://operate-api.essensys.tech/api/1.0/invoiceline

A row of an Invoice, representing a charge.

Note: reference to an invoiceline is by draftinvoicelineid

GET https://operate-api.essensys.tech/api/1.0/invoiceline/22

{
    "response": {
        "id": "d36a8cea-29bc-40f3-a88e-e338744108fc",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/07/2017 11:29:25",
        "invoicelines": [
            {
                "row_num": "1",
                "accountsid": "1",
                "outputvalue_accountsid": "1",
                "bundledproduct": "0",
                "createdby": "RJMETIS\\mari",
                "outputvalue_createdby": "RJMETIS\\mari",
                "creationdate": "2016-07-01T17:07:34+00:00",
                "outputvalue_creationdate": "2016-07-01T17:07:34+00:00",
                "discountfromlist": "500",
                "outputvalue_discountfromlist": "500",
                "draftinvoicelineid": "22",
                "outputvalue_draftinvoicelineid": "22",
                "from": "2016-04-01T00:00:00+00:00",
                "outputvalue_from": "2016-04-01T00:00:00+00:00",
                "glcode": "1000",
                "outputvalue_glcode": "1000",
                "invoice": "345",
                "listprice": "1000",
                "outputvalue_listprice": "1000",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "order": "1",
                "outputvalue_order": "1",
                "originalbundle": "0",
                "outputvalue_originalbundle": "0",
                "product": "74",
                "outputvalue_product": "Room 2",
                "productgroup": "24",
                "outputvalue_productgroup": "Office Rent",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": "01/04/2016 - 30/04/2016",
                "outputvalue_referencetext": "01/04/2016 - 30/04/2016",
                "tax": "5",
                "outputvalue_tax": "0.2",
                "taxcode": "1",
                "outputvalue_taxcode": "1",
                "taxname": "5",
                "outputvalue_taxname": "20% Tax rate",
                "taxrate": "0.2",
                "outputvalue_taxrate": "20%",
                "to": "2016-04-30T00:00:00+00:00",
                "outputvalue_to": "2016-04-30T00:00:00+00:00",
                "updatedate": "2016-07-01T17:07:34+00:00",
                "outputvalue_updatedate": "2016-07-01T17:07:34+00:00",
                "updatedby": "RJMETIS\\mari",
                "outputvalue_updatedby": "RJMETIS\\mari"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
accountsid int accountsid from Account Note this is different from accountid
bundledproduct
createdby string 255 fullname from User
creationdate date
discountfromlist
draftinvoicelineid int Reference to the Invoice Line
from date
glcode string 255 General Ledger Code applied to all Products. Typically used when performing Financial Exports to third party applications.
invoice int invoiceid from Invoice
listprice currency
location int locationid from Location
markup string % or currency amount
markuptype int 1 = % , 2 = Currency Amount
order
originalbundle
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext string 255
tax int taxid from Tax
taxcode string 10
taxname int taxid from Tax
taxrate taxrate from Tax
to date
updatedate date
updatedby string 255 fullname from User

Invoice Number

https://operate-api.essensys.tech/api/1.0/invoicenumber

Each Invoice is allocated an Invoice Number. The allocation is consecutive and may include a Prefix depending on the Location, Client Type or Organization

GET https://operate-api.essensys.tech/api/1.0/invoicenumber/5

{
    "response": {
        "id": "abf48327-0df9-4709-9a49-9981f29f41cd",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 14:48:48",
        "invoicenumbers": [
            {
                "row_num": "1",
                "createdby": "DOMAIN\\smith",
                "outputvalue_createdby": "DOMAIN\\smith",
                "creationdate": "2016-07-01T09:50:54+00:00",
                "outputvalue_creationdate": "2016-07-01T09:50:54+00:00",
                "invoicenumberid": "5",
                "outputvalue_invoicenumberid": "5",
                "invoiceprefix": "7A-",
                "outputvalue_invoiceprefix": "7A-",
                "invoicenumber": "0",
                "outputvalue_invoicenumber": "0",
                "updatedate": "2016-07-01T09:50:54+00:00",
                "outputvalue_updatedate": "2016-07-01T09:50:54+00:00",
                "updatedby": "DOMAIN\\smith",
                "outputvalue_updatedby": "DOMAIN\\smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
invoicenumberid int Reference to the Invoice Number
invoiceprefix string Alphanumeric field that goes before the invoice number. It can be configured per Organization, Location or Client Type.
invoicenumber
updatedate date
updatedby string 255 fullname from User

Invoice Order

https://operate-api.essensys.tech/api/1.0/invoiceorder

GET

{
    "response": {
        "id": "51176d14-ac8b-4a53-9ff2-7ae5f15474b8",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 14:57:18",
        "invoiceorders": [
            {
                "row_num": "1",
                "createdby": "DOMAIN\\smith",
                "outputvalue_createdby": "DOMAIN\\smith",
                "creationdate": "2016-07-01T09:57:45+00:00",
                "outputvalue_creationdate": "2016-07-01T09:57:45+00:00",
                "sortorder": "1",
                "outputvalue_sortorder": "1",
                "productgroup": "Office Rent",
                "outputvalue_productgroup": "Office Rent",
                "productgroupid": "24",
                "outputvalue_productgroupid": "24",
                "updatedate": "2016-07-01T09:57:45+00:00",
                "outputvalue_updatedate": "2016-07-01T09:57:45+00:00",
                "updatedby": "DOMAIN\\smith",
                "outputvalue_updatedby": "DOMAIN\\smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
sortorder
productgroup string
productgroupid int productgroupid from Product Group
updatedate date
updatedby string 255 fullname from User

Invoice Summary

A summarized view of invoiced transactions that only contains totals per Product Group.

GET

{
    "response": {
        "id": "682ee1a4-c9b0-469a-94aa-d9b124ed823e",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "01/08/2017 10:11:21",
        "invoicesummarys": [
            {
                "row_num": "1",
                "createdby": "live",
                "outputvalue_createdby": "live",
                "creationdate": "2017-05-05T13:58:22+00:00",
                "outputvalue_creationdate": "2017-05-05T13:58:22+00:00",
                "creditnoteid": "1011",
                "draftcreditnoteid": "1011",
                "draftinvoiceid": "1011",
                "invoiceid": "1011",
                "invoicesummaryname": "Office Rent",
                "outputvalue_invoicesummaryname": "Office Rent",
                "invoicesummaryid": "00001011000024",
                "outputvalue_invoicesummaryid": "00001011000024",
                "order": "1",
                "outputvalue_order": "1",
                "recordtype": "0",
                "summarytotal": "428.57",
                "outputvalue_summarytotal": "428.57",
                "updatedate": "2017-05-05T13:58:22+00:00",
                "outputvalue_updatedate": "2017-05-05T13:58:22+00:00",
                "updatedby": "live",
                "outputvalue_updatedby": "live"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
creditnoteid int
draftcreditnoteid int
draftinvoiceid int
invoiceid int
invoicesummaryname string
invoicesummaryid string Reference to the Invoice Summary
order
recordtype int recordtypeid from Record Type
summarytotal decimal
updatedate date
updatedby string 255 fullname from User

Journals

A Journal entry within Accounts Receivable. Journals can either be credit or debit. Journals are associated to a GL Code and can be allocated to an Invoice.

Journal

https://operate-api.essensys.tech/api/1.0/journal

GET https://operate-api.essensys.tech/api/1.0/journal/

{
    "response": {
        "id": "4b36fcc1-d525-4c9b-8c03-f29141c41ec9",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "22/08/2017 10:54:51",
        "journals": [
            {
                "row_num": "1",
                "accountname": "12",
                "outputvalue_accountname": "UK Marketing Team",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-22T10:54:39+00:00",
                "outputvalue_creationdate": "2017-08-22T10:54:39+00:00",
                "glcode": "1000",
                "journaldate": "2017-08-22T00:00:00+00:00",
                "outputvalue_journaldate": "2017-08-22T00:00:00+00:00",
                "journalcreditid": "1114",
                "outputvalue_journalcreditid": "1114",
                "journalid": "1114",
                "outputvalue_journalid": "1114",
                "journaltype": "12",
                "outputvalue_journaltype": "12",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "reference": "Test 12",
                "outputvalue_reference": "Test 12",
                "updatedate": "2017-08-22T10:54:39+00:00",
                "outputvalue_updatedate": "2017-08-22T10:54:39+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON body

{
    "journals": [
        {
            "accountname": "12",
            "glcode": "1000",
            "journaldate": "22/10/2013",
            "journaltype": "12",
            "reference": ""
        }
    ]
}

PUT (Full) JSON body

{
    "journals": [
        {
            "accountname": "12",
            "allocateto": "Darren Smith",
            "amount": "£0.00",
            "comments": "This is very long text which can go over multiple lines",
            "paymentcurrencycode": "",
            "paymentexchangerate": "125",
            "glcode": "1000",
            "journaldate": "22/10/2013",
            "journalproduct": "",
            "journaltype": "12",
            "reference": ""
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
allocateto string 32767
amount currency
comments string
createdby string 255 fullname from User
creationdate date
glcode int glcodeid from GL Code
journalcreditid int
journaldate date
journalid int Reference to the Journal
journalproduct int productid from Product
journaltype int 12=Journal Credit , 13=Journal Debit
location int locationid from Location
paymentcurrencycode string currencyname from ExchangeRate
paymentexchangerate decimal exchangerate from ExchangeRate
reference string 255
updatedate date
updatedby string 255 fullname from User

Leads

Leads are enquiries that companies or individuals submit to your organization.

A Lead can be added manually or sent automatically Web To Lead.

All Leads require a Location. All come from a Lead Source which can vary from a broker to a walk-in. Leads can be rejected (Lead Rejection Reasons) or overturned (Lead Overturn Reasons).

Lead

https://operate-api.essensys.tech/api/1.0/lead

An enquiry that a business entity makes to your Organization.

Activity History, Note, Unreadable Lead and Web To Lead can reference a leadid.

GET https://operate-api.essensys.tech/api/1.0/Lead/64

{
    "response": {
        "id": "c1d77c36-2cc6-4240-ad38-636354cc910f",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 11:39:18",
        "leads": [
            {
                "row_num": "1",
                "addressline1": null,
                "outputvalue_addressline1": null,
                "addressline2": null,
                "outputvalue_addressline2": null,
                "addressline3": null,
                "outputvalue_addressline3": null,
                "broker": "0",
                "agentcontact": "0",
                "agentemail": null,
                "outputvalue_agentemail": null,
                "brokerfirstname": null,
                "outputvalue_brokerfirstname": null,
                "brokerlastname": null,
                "outputvalue_brokerlastname": null,
                "agentreference": null,
                "outputvalue_agentreference": null,
                "leadstatus": "0",
                "outputvalue_leadstatus": "0",
                "brokerupdated": "true",
                "outputvalue_brokerupdated": "true",
                "budget": null,
                "outputvalue_budget": null,
                "campaign_id": "0",
                "clienttype": "0",
                "leadname": "Coalition",
                "outputvalue_leadname": "Coalition",
                "leadconverted": "true",
                "outputvalue_leadconverted": "true",
                "leadconvertedby": "Administrator",
                "outputvalue_leadconvertedby": "Administrator",
                "leadconverteddate": "2016-11-29T16:42:39+00:00",
                "outputvalue_leadconverteddate": "2016-11-29T16:42:39+00:00",
                "country": null,
                "outputvalue_country": null,
                "county": null,
                "outputvalue_county": null,
                "createdby": "Administrator",
                "outputvalue_createdby": "Administrator",
                "creationdate": "2016-11-29T16:37:59+00:00",
                "outputvalue_creationdate": "2016-11-29T16:37:59+00:00",
                "daysopen": "0",
                "outputvalue_daysopen": "0",
                "deadlead": "false",
                "outputvalue_deadlead": "false",
                "deadreason": null,
                "outputvalue_deadreason": null,
                "emailaddress": "a@a.com",
                "outputvalue_emailaddress": "a@a.com",
                "enquirydate": "2016-11-29T16:33:44+00:00",
                "outputvalue_enquirydate": "2016-11-29T16:33:44+00:00",
                "eventenddate": "2001-01-01T00:00:00+00:00",
                "outputvalue_eventenddate": "2001-01-01T00:00:00+00:00",
                "eventstartdate": "2001-01-01T00:00:00+00:00",
                "outputvalue_eventstartdate": "2001-01-01T00:00:00+00:00",
                "eventname": null,
                "outputvalue_eventname": null,
                "firstname": "Wellie",
                "outputvalue_firstname": "Wellie",
                "industry": "Accounting",
                "outputvalue_industry": "Accounting",
                "multidaybooking": "false",
                "outputvalue_multidaybooking": "false",
                "lastname": "Smith",
                "outputvalue_lastname": "Smith",
                "leadsource": "Walk in",
                "outputvalue_leadsource": "Walk in",
                "leadstatusid": "2",
                "outputvalue_leadstatusid": "2",
                "leadtype": null,
                "outputvalue_leadtype": null,
                "leaddadilead": "false",
                "outputvalue_leaddadilead": "false",
                "leadid": "64",
                "outputvalue_leadid": "64",
                "locationname": "4",
                "outputvalue_locationname": "7th Avenue",
                "locationrequired": null,
                "outputvalue_locationrequired": null,
                "mobileno": "1234567",
                "outputvalue_mobileno": "1234567",
                "numberofpeople": null,
                "outputvalue_numberofpeople": null,
                "otherneeds": null,
                "outputvalue_otherneeds": null,
                "user_id": "27",
                "outputvalue_user_id": "Anthony Smith",
                "postcode": null,
                "outputvalue_postcode": null,
                "qualityofspace": null,
                "outputvalue_qualityofspace": null,
                "recordtype": "2",
                "outputvalue_recordtype": "Lead",
                "region_id": "0",
                "secondeventenddate": "2001-01-01T00:00:00+00:00",
                "outputvalue_secondeventenddate": "2001-01-01T00:00:00+00:00",
                "secondeventstartdate": "2001-01-01T00:00:00+00:00",
                "outputvalue_secondeventstartdate": "2001-01-01T00:00:00+00:00",
                "size": null,
                "outputvalue_size": null,
                "spacetype": null,
                "outputvalue_spacetype": null,
                "noofduplicates": "0",
                "outputvalue_noofduplicates": "0",
                "phoneno": "123456",
                "outputvalue_phoneno": "123456",
                "term": null,
                "outputvalue_term": null,
                "timing": null,
                "outputvalue_timing": null,
                "town": null,
                "outputvalue_town": null,
                "updatedate": "2016-11-29T16:42:39+00:00",
                "outputvalue_updatedate": "2016-11-29T16:42:39+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator",
                "webtolead": "false",
                "outputvalue_webtolead": "false",
                "website": "www.example.com",
                "outputvalue_website": "www.example.com"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "leads": [
        {
            "locationname": "Item from list"
        }
    ]
}

PUT (Full) JSON Body

{
    "leads": [
        {
            "addressline1": "",
            "addressline2": "",
            "addressline3": "",
            "broker": "Item from list",
            "agentcontact": "Item from list",
            "agentemail": "darren@domain.com",
            "agentreference": "",
            "leadstatus": "Selected item",
            "brokerupdated": "True",
            "budget": "",
            "campaign_id": "Item from list",
            "clienttype": "Item from list",
            "leadname": "Darren Smith",
            "leadconverted": "True",
            "leadconvertedby": "Darren Smith",
            "leadconverteddate": "22/10/2013 12:23",
            "country": "",
            "county": "",
            "deaddate": "22/10/2013 12:23",
            "deadreason": "Item from list",
            "emailaddress": "darren@domain.com",
            "enquirydate": "22/10/2013 12:23",
            "eventenddate": "22/10/2013 12:23",
            "eventstartdate": "22/10/2013 12:23",
            "eventname": "",
            "faxno": "+44 845 303 1000",
            "firstname": "Darren",
            "floor": "",
            "ud_iaminterestedin": "Select Item 1, Selected Item 2",
            "industry": "Item from list",
            "multidaybooking": "True",
            "lastname": "Smith",
            "leadsource": "Item from list",
            "leadstatusid": "Selected item",
            "leadtype": "Item from list",
            "leaddadilead": "True",
            "locationname": "Item from list",
            "locationrequired": "",
            "mobileno": "07111 211211",
            "noofattendees": "1,2345",
            "numberofpeople": "",
            "otherneeds": "This is text area",
            "user_id": "Item from list",
            "postcode": "",
            "qualityofspace": "",
            "region_id": "Item from list",
            "registeredaddresscountry": "",
            "registeredaddresscounty": "",
            "registeredaddressline1": "",
            "registeredaddressline2": "",
            "registeredaddressline3": "",
            "registeredaddresspostcode": "",
            "registeredaddresstown": "",
            "secondeventenddate": "22/10/2013 12:23",
            "secondeventstartdate": "22/10/2013 12:23",
            "size": "",
            "spacetype": "",
            "startdate": "22/10/2013",
            "phoneno": "+44 845 303 1000",
            "term": "",
            "ud_timeline": "Selected item",
            "timing": "",
            "ud_tourrequested": "True",
            "town": "",
            "webtolead": "True",
            "website": "http://www.spacedadi.com"
        }
    ]
}
Field Type Size Description
addressline1 string 255
addressline2 string 255
addressline3 string 255
broker int accountid from Account
agentcontact int
agentemail string 255
brokerfirstname string
brokerlastname string
agentreference string 255
brokerupdated boolean
budget string
campaign_id int campaignid from Email Campaign
clienttype int clienttypeid from Client Type
country string 255 Countries
county string 255 Counties
createdby string 255 fullname from User
creationdate date
daysopen int
deadlead false
deadreason int Dead Lead Reason
emailaddress string
enquirydate date
eventenddate date
eventstartdate date
eventname string 255
firstname string 255
industry string industry from Industry
lastname string 255
leadconverted boolean
leadconvertedby string 255
leadconverteddate date
leaddadilead boolean
leadid int Reference to the lead
leadname string
leadsource string from Lead Source
leadstatusid int
leadtype int leadtypeid from Lead Type
leadstatus int
locationname int locationid from Location
locationrequired string 255
mobileno string
multidaybooking boolean
numberofpeople string 255
otherneeds string 4000
user_id int userid from User
postcode string 10
qualityofspace string 255
recordtype int recordtypeid from Record Type
region_id int regionid from Region
registeredaddresscountry string 255
registeredaddresscounty string 255
registeredaddressline1 string 255
registeredaddressline2 string 255
registeredaddressline3 string 255
registeredaddresspostcode string 20
registeredaddresstown string 255
secondeventenddate date
secondeventstartdate date
size string 255 SqFt
spacetype string
noofduplicates int
phoneno string
term string 255
timing string
town string 255
updatedate date
updatedby string 255 fullname from User
webtolead boolean
website string

Dead Lead Reason

https://operate-api.essensys.tech/api/1.0/deadleadreason

GET https://operate-api.essensys.tech/api/1.0/deadleadreason/540

curl https://operate-api.essensys.tech/api/1.0/deadleadreason/540 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "9ecb4570-7fc8-4619-a0a4-57c49aebd751",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "24/07/2017 16:18:38",
        "deadleadreasons": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:22:45+00:00",
                "outputvalue_creationdate": "2009-08-13T15:22:45+00:00",
                "deadleadreason": "Window Shopper ",
                "outputvalue_deadleadreason": "Window Shopper ",
                "deadleadreasonid": "540",
                "outputvalue_deadleadreasonid": "540",
                "updatedate": "2009-08-13T15:22:45+00:00",
                "outputvalue_updatedate": "2009-08-13T15:22:45+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
deadleadreason string 255
deadleadreasonid int Reference to the Dead Lead Reason
updatedate date

Lead Overturn Reasons

https://operate-api.essensys.tech/api/1.0/lookupleadoverturnreasons

GET https://operate-api.essensys.tech/api/1.0/lookupleadoverturnreasons/558

{
    "response": {
        "id": "f3513531-7dfd-43ee-8aee-7d42dde11837",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "01/08/2017 10:38:34",
        "lookupleadoverturnreasonss": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:27:44+00:00",
                "outputvalue_creationdate": "2009-08-13T15:27:44+00:00",
                "leadoverturnreason": "Overturn",
                "outputvalue_leadoverturnreason": "Overturn",
                "leadoverturnreasonsid": "558",
                "outputvalue_leadoverturnreasonsid": "558",
                "updatedate": "2009-08-13T15:27:44+00:00",
                "outputvalue_updatedate": "2009-08-13T15:27:44+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
leadoverturnreason string 255
leadoverturnreasonsid int Reference to the Lead Overturn Reason
updatedate date

Lead Rejection Reasons

https://operate-api.essensys.tech/api/1.0/lookupleadrejectionreasons

GET https://operate-api.essensys.tech/api/1.0/lookupleadrejectionreasons/559

{
    "response": {
        "id": "092cb0da-216f-4bc8-a5d2-285b75a38845",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "01/08/2017 10:36:24",
        "lookupleadrejectionreasonss": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:28:04+00:00",
                "outputvalue_creationdate": "2009-08-13T15:28:04+00:00",
                "leadrejectionreason": "Duplicate",
                "outputvalue_leadrejectionreason": "Duplicate",
                "leadrejectionreasonsid": "559",
                "outputvalue_leadrejectionreasonsid": "559",
                "updatedate": "2009-08-13T15:28:04+00:00",
                "outputvalue_updatedate": "2009-08-13T15:28:04+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
leadrejectionreason string 255
leadrejectionreasonsid int Reference to the Lead Reject Reason
updatedate date

Lead Source

https://operate-api.essensys.tech/api/1.0/leadsource

Represents the original source of a Lead. This could be a broker, walk-in, website, etc.

GET https://operate-api.essensys.tech/api/1.0/leadsource/596

{
    "response": {
        "id": "bced2e72-7039-477d-95d4-c614d727820c",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 17:49:54",
        "leadsources": [
            {
                "row_num": "1",
                "creationdate": "2011-01-15T17:29:00+00:00",
                "outputvalue_creationdate": "2011-01-15T17:29:00+00:00",
                "leadsource": "Email Campaign",
                "outputvalue_leadsource": "Email Campaign",
                "leadsourceid": "596",
                "outputvalue_leadsourceid": "596",
                "updatedate": "2011-01-15T17:29:00+00:00",
                "outputvalue_updatedate": "2011-01-15T17:29:00+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
leadsource string
leadsourceid int Reference to the Lead Source
updatedate date

Lead Type

https://operate-api.essensys.tech/api/1.0/leadtype

Used by Lead and Opportunity

GET https://operate-api.essensys.tech/api/1.0/leadtype/568

{
    "response": {
        "id": "d073db06-06ee-4eb4-9311-68645643f278",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 17:57:06",
        "leadtypes": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:31:35+00:00",
                "outputvalue_creationdate": "2009-08-13T15:31:35+00:00",
                "leadtypename": "Hot Lead ",
                "outputvalue_leadtypename": "Hot Lead ",
                "leadtypeid": "568",
                "outputvalue_leadtypeid": "568",
                "updatedate": "2009-08-13T15:31:35+00:00",
                "outputvalue_updatedate": "2009-08-13T15:31:35+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Full) JSON Body

{
    "leadtypes": [
        {
            "leadtypename": ""
        }
    ]
}
Field Type Size Description
creationdate date
leadtypename string 255
leadtypeid int Reference to the Lead Type
updatedate date

Unreadable Lead

https://operate-api.essensys.tech/api/1.0/unreadablelead

A Lead sent to your LeadDADI address with a missing or incorrect .xml attachment.

PUT (Full) JSON Body

{
    "unreadableleads": [
        {
            "leadhtml": {
                "strong": "html"
            },
            "preview": "",
            "datereceived": "22/10/2013 12:23",
            "datesent": "22/10/2013 12:23",
            "subject": "",
            "unreadableleadid": ""
        }
    ]
}
Field Type Size Description
leadhtml object
preview string
datereceived date
datesent date
subject string
unreadableleadid Reference to the Unreadable Lead

Web To Lead

https://operate-api.essensys.tech/api/1.0/webtolead

Web To Lead uses an HTML Form to capture Leads from a website into Operate.

PUT (Minimum) JSON Body

{
    "webtoleads": [
        {
            "htmlbody": {
                "strong": "html"
            },
            "recordtypevalues": "Item from list",
            "selectedfields": "",
            "defaultleadcreator": "Item from list",
            "webtoleadname": ""
        }
    ]
}

PUT (Full) JSON Body

{
    "webtoleads": [
        {
            "returnurl": "http://www.spacedadi.com",
            "enabled": "True",
            "htmlbody": {
                "strong": "html"
            },
            "recordtypevalues": "Item from list",
            "selectedfields": "",
            "defaultleadcreator": "Item from list",
            "webtoleadname": ""
        }
    ]
} 
Field Type Size Description
createdby string 255 fullname from User
creationdate date
defaultleadcreator int userid from User
htmlbody object 32767
enabled boolean
recordtype int recordtypeid from Record Type
recordtypevalues
returnurl string 255
selectedfields string 32767
updatedate date
updatedby string 255 fullname from User
webtoleadid int Reference to the WebToLead
webtoleadname string 255

Licensing

Licences represent the contract agreements that you sign with your customers’ Accounts.

They allow you to keep track of all of the terms agreed upon, as well as the Products that each customer chooses to purchase from your organization.

Licence

https://operate-api.essensys.tech/api/1.0/licence

A License is comprised of License Items.

A license requires a Location and an Account.

Activity History, Break Date, Licence Item, Licence Proforma Invoice Line, Licence Proforma Tax Summary, Note and Task can reference a Licence by its licenceid.

GET https://operate-api.essensys.tech/api/1.0/licence

{
    "response": {
        "id": "ca46cdab-d861-4bf8-aad5-b2f16b645425",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "10/07/2017 13:54:47",
        "licences": [
            {
                "row_num": "1",
                "accountname": "65",
                "outputvalue_accountname": "Coalition",
                "workstations": "0",
                "outputvalue_workstations": "0",
                "additionaldeposit": "800",
                "outputvalue_additionaldeposit": "800",
                "additionalproductnames": null,
                "outputvalue_additionalproductnames": null,
                "additionalproductprices": null,
                "outputvalue_additionalproductprices": null,
                "additionalproductquantities": null,
                "outputvalue_additionalproductquantities": null,
                "additionalproducttotalprices": null,
                "outputvalue_additionalproducttotalprices": null,
                "addressline1": null,
                "outputvalue_addressline1": null,
                "addressline2": null,
                "outputvalue_addressline2": null,
                "addressline3": null,
                "outputvalue_addressline3": null,
                "agreementno": "0000000014",
                "outputvalue_agreementno": "0000000014",
                "agreementtype": "0",
                "approvedby": "0",
                "autorenew": "false",
                "outputvalue_autorenew": "false",
                "contactid": "155",
                "outputvalue_contactid": "Wellie Chao",
                "billingpattern": null,
                "outputvalue_billingpattern": null,
                "clienttype": "6",
                "outputvalue_clienttype": "Residential",
                "companyno": null,
                "outputvalue_companyno": null,
                "contact": "155",
                "outputvalue_contact": "Wellie Chao",
                "contractdiscount": "0",
                "outputvalue_contractdiscount": "0%",
                "contractlistprice": "0.0000",
                "outputvalue_contractlistprice": "0.0000",
                "contractservicenames": null,
                "outputvalue_contractservicenames": null,
                "contractserviceprices": null,
                "outputvalue_contractserviceprices": null,
                "contractservicequantities": null,
                "outputvalue_contractservicequantities": null,
                "contractservicetotalprices": null,
                "outputvalue_contractservicetotalprices": null,
                "contractvalue": "4243.2877",
                "outputvalue_contractvalue": "4243.2877",
                "countersignuser": "0",
                "country": null,
                "outputvalue_country": null,
                "county": null,
                "outputvalue_county": null,
                "createdby": "Administrator",
                "outputvalue_createdby": "Administrator",
                "creationdate": "2016-12-07T16:41:19+00:00",
                "outputvalue_creationdate": "2016-12-07T16:41:19+00:00",
                "depositheld": "0.0000",
                "outputvalue_depositheld": "0.0000",
                "directdebit": "false",
                "outputvalue_directdebit": "false",
                "emailaddress": "a@a.com",
                "outputvalue_emailaddress": "a@a.com",
                "escalateby": "0",
                "outputvalue_escalateby": "0",
                "escalationmonths": "0",
                "outputvalue_escalationmonths": "0",
                "expansionvalue": "0.0000",
                "outputvalue_expansionvalue": "0.0000",
                "faxno": null,
                "outputvalue_faxno": null,
                "industry": null,
                "outputvalue_industry": null,
                "leadsource": "561",
                "outputvalue_leadsource": "Walk in",
                "licencename": "Agreement version1",
                "outputvalue_licencename": "Agreement version1",
                "licencestatus": "Draft",
                "outputvalue_licencestatus": "Draft",
                "licencetemplate": "1",
                "outputvalue_licencetemplate": "Default Simple Licence",
                "licencetype": "0",
                "outputvalue_licencetype": "0",
                "licenceid": "14",
                "outputvalue_licenceid": "14",
                "locationname": "4",
                "outputvalue_locationname": "7th Avenue",
                "mandatorychargesloaded": "false",
                "outputvalue_mandatorychargesloaded": "false",
                "meetingpackageid": "0",
                "mobileno": null,
                "outputvalue_mobileno": null,
                "newmember": "false",
                "outputvalue_newmember": "false",
                "noticegiven": "1",
                "outputvalue_noticegiven": "1",
                "noticeperiod": "2",
                "outputvalue_noticeperiod": "2",
                "monthlyoffice": "400",
                "outputvalue_monthlyoffice": "400",
                "monthlyofficetax": "0.0000",
                "outputvalue_monthlyofficetax": "0.0000",
                "offices": "Room 11",
                "outputvalue_offices": "Room 11",
                "onboardingemailsent": "false",
                "outputvalue_onboardingemailsent": "false",
                "opportunity": "0",
                "opportunitytype": "600",
                "outputvalue_opportunitytype": "New Customer- Self Sourced",
                "originallicenceagreementid": "0",
                "outputvalue_originallicenceagreementid": "0",
                "postcode": null,
                "outputvalue_postcode": null,
                "items": "Room 11",
                "outputvalue_items": "Room 11",
                "quoteid": "0",
                "outputvalue_quoteid": "0",
                "quoteoptionid": "0",
                "registeredaddressline1": null,
                "outputvalue_registeredaddressline1": null,
                "registeredaddressline2": null,
                "outputvalue_registeredaddressline2": null,
                "registeredaddressline3": null,
                "outputvalue_registeredaddressline3": null,
                "registeredcountry": null,
                "outputvalue_registeredcountry": null,
                "registeredcounty": null,
                "outputvalue_registeredcounty": null,
                "registeredfaxno": null,
                "outputvalue_registeredfaxno": null,
                "registeredpostcode": null,
                "outputvalue_registeredpostcode": null,
                "registeredphoneno": null,
                "outputvalue_registeredphoneno": null,
                "registeredtown": null,
                "outputvalue_registeredtown": null,
                "renewalterm": "12",
                "outputvalue_renewalterm": "12",
                "renewed": "false",
                "outputvalue_renewed": "false",
                "renewing": "false",
                "outputvalue_renewing": "false",
                "rentuplift": "0",
                "outputvalue_rentuplift": "0%",
                "rentschedulemonths": "Dec 2016<br>Jan 2017<br>Feb 2017<br>Mar 2017<br>Apr 2017<br>May 2017<br>Jun 2017<br>Jul 2017<br>Aug 2017<br>Sep 2017<br>Oct 2017<br>Nov 2017<br>Dec 2017<br>",
                "outputvalue_rentschedulemonths": "Dec 2016<br>Jan 2017<br>Feb 2017<br>Mar 2017<br>Apr 2017<br>May 2017<br>Jun 2017<br>Jul 2017<br>Aug 2017<br>Sep 2017<br>Oct 2017<br>Nov 2017<br>Dec 2017<br>",
                "rentscheduleprices": "$200.00<br>$164.38<br>$200.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$78.90<br>",
                "outputvalue_rentscheduleprices": "$200.00<br>$164.38<br>$200.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$400.00<br>$78.90<br>",
                "rentvalue": "0.0000",
                "outputvalue_rentvalue": "0.0000",
                "rollinglicence": "true",
                "outputvalue_rollinglicence": "true",
                "rollingbreakdates": "false",
                "outputvalue_rollingbreakdates": "false",
                "salesperson": "25",
                "outputvalue_salesperson": "Amanda Fanoun",
                "schedule": "0",
                "outputvalue_schedule": "One Off",
                "serviceuplift": "0",
                "outputvalue_serviceuplift": "0%",
                "monthlyservice": "0.0000",
                "outputvalue_monthlyservice": "0.0000",
                "monthlyservicetax": "0.0000",
                "outputvalue_monthlyservicetax": "0.0000",
                "servicevalue": "0.0000",
                "outputvalue_servicevalue": "0.0000",
                "services": "Deposit US\nRoom 11",
                "outputvalue_services": "Deposit US\nRoom 11",
                "showbreakdates": "false",
                "outputvalue_showbreakdates": "false",
                "specialterms": null,
                "outputvalue_specialterms": null,
                "startdate": "2016-12-07T00:00:00+00:00",
                "outputvalue_startdate": "2016-12-07T00:00:00+00:00",
                "licencestatusid": "0",
                "outputvalue_licencestatusid": "Draft",
                "suminsured": "0.0000",
                "outputvalue_suminsured": "0.0000",
                "suretyaddress1": null,
                "outputvalue_suretyaddress1": null,
                "suretyaddress2": null,
                "outputvalue_suretyaddress2": null,
                "suretyaddress3": null,
                "outputvalue_suretyaddress3": null,
                "suretycountry": null,
                "outputvalue_suretycountry": null,
                "suretycounty": null,
                "outputvalue_suretycounty": null,
                "suretyemail": null,
                "outputvalue_suretyemail": null,
                "suretymobile": null,
                "outputvalue_suretymobile": null,
                "suretypostcode": null,
                "outputvalue_suretypostcode": null,
                "suretyrequired": "false",
                "outputvalue_suretyrequired": "false",
                "suretytelephone": null,
                "outputvalue_suretytelephone": null,
                "suretytown": null,
                "outputvalue_suretytown": null,
                "taxnumber": null,
                "outputvalue_taxnumber": null,
                "phoneno": "123456",
                "outputvalue_phoneno": "123456",
                "termmonths": "12",
                "outputvalue_termmonths": "12",
                "termdays": "0",
                "outputvalue_termdays": "0",
                "enddate": "2017-12-06T00:00:00+00:00",
                "outputvalue_enddate": "2017-12-06T00:00:00+00:00",
                "monthlytotal": "400",
                "outputvalue_monthlytotal": "400",
                "monthlygross": "400",
                "outputvalue_monthlygross": "400",
                "monthlytax": "0.0000",
                "outputvalue_monthlytax": "0.0000",
                "town": null,
                "outputvalue_town": null,
                "transferred": "false",
                "outputvalue_transferred": "false",
                "transferring": "false",
                "outputvalue_transferring": "false",
                "updatedate": "2016-12-07T16:41:19+00:00",
                "outputvalue_updatedate": "2016-12-07T16:41:19+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator",
                "valueofgoods": "0.0000",
                "outputvalue_valueofgoods": "0.0000",
                "virtualuplift": "0",
                "outputvalue_virtualuplift": "0%",
                "monthlyvirtual": "0.0000",
                "outputvalue_monthlyvirtual": "0.0000",
                "monthlyvirtualtax": "0.0000",
                "outputvalue_monthlyvirtualtax": "0.0000",
                "virtualvalue": "0.0000",
                "outputvalue_virtualvalue": "0.0000"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON body

{
    "licences": [
        {
            "accountname": "Item from list",
            "licencename": "",
            "locationname": "Item from list"
        }
    ]
}

PUT (Full) JSON body

{
    "licences": [
        {
            "accountname": "Item from list",
            "accountreferencetext": "",
            "workstations": "1,2345",
            "addressline1": "",
            "addressline2": "",
            "addressline3": "",
            "agreementtype": "Item from list",
            "approvalrequestor": "Item from list",
            "approvedby": "Item from list",
            "autorenew": "True",
            "contactid": "Item from list",
            "billingpattern": "Selected item",
            "clienttype": "Item from list",
            "comments": "This is very long text which can go over multiple lines",
            "companyno": "",
            "contact": "Item from list",
            "contractdiscount": "100%",
            "contractlistprice": "£0.00",
            "contractvalue": "£0.00",
            "countersignuser": "Item from list",
            "country": "",
            "county": "Cornwall",
            "dateecountersigned": "22/10/2013 12:23",
            "dateesigned": "22/10/2013 12:23",
            "datelicenceissued": "22/10/2013 12:23",
            "datelicencesigned": "22/10/2013",
            "datenoticegiven": "22/10/2013",
            "depositheld": "£0.00",
            "directdebit": "True",
            "escalateby": "1,2345",
            "escalationdate": "22/10/2013",
            "escalationmonths": "1,2345",
            "esignstatus": "This is encrypted text",
            "excludedservices": "This is very long text which can go over multiple lines",
            "expansionvalue": "£0.00",
            "expectedmoveout": "22/10/2013",
            "faxno": "+44 845 303 1000",
            "includedservices": "This is very long text which can go over multiple lines",
            "industry": "Item from list",
            "licenceissuedby": "Darren",
            "leadsource": "Item from list",
            "licencename": "",
            "licencetemplate": "Item from list",
            "licencetype": "Selected item",
            "locationname": "Item from list",
            "mandatorychargesloaded": "True",
            "meetingpackageid": "Item from list",
            "mobileno": "07111 211211",
            "newlicenceagreementid": "1,2345",
            "newmember": "True",
            "noticeperiod": "1,2345",
            "officenames": "",
            "onboardingemailsent": "True",
            "opportunity": "Item from list",
            "opportunitytype": "Item from list",
            "originalenddate": "22/10/2013",
            "originallicenceagreementid": "123",
            "parkingspaces": "123",
            "postcode": "",
            "items": "",
            "quoteid": "Item from list",
            "quoteoptionid": "Item from list",
            "unapprovedreason": "This is very long text which can go over multiple lines",
            "referencetext": "",
            "registeredaddressline1": "",
            "registeredaddressline2": "",
            "registeredaddressline3": "",
            "registeredcountry": "",
            "registeredcounty": "Cornwall",
            "registeredfaxno": "+44 845 303 1000",
            "registeredpostcode": "",
            "registeredphoneno": "+44 845 303 1000",
            "registeredtown": "",
            "renewalstartdate": "22/10/2013",
            "renewalterm": "1,2345",
            "renewed": "True",
            "renewing": "True",
            "rentuplift": "100%",
            "rentvalue": "£0.00",
            "rollinglicence": "True",
            "rollingbreakdates": "True",
            "salesperson": "Item from list",
            "schedule": "Item from list",
            "serviceuplift": "100%",
            "servicenames": "",
            "servicevalue": "£0.00",
            "showbreakdates": "True",
            "specialterms": "This is very long text which can go over multiple lines",
            "startdate": "22/10/2013",
            "licencestatusid": "Item from list",
            "suminsured": "£0.00",
            "suretyaddress1": "",
            "suretyaddress2": "",
            "suretyaddress3": "",
            "suretycontact": "",
            "suretycountry": "",
            "suretycounty": "",
            "suretyemail": "darren@domain.com",
            "suretymobile": "07111 211211",
            "suretypostcode": "",
            "suretyrequired": "True",
            "suretytelephone": "+44 845 303 1000",
            "suretytown": "",
            "taxnumber": "",
            "termmonths": "1,2345",
            "termdays": "1,2345",
            "enddate": "22/10/2013",
            "terminatedby": "",
            "terminatedon": "22/10/2013 12:23",
            "terminationdate": "22/10/2013",
            "town": "Town",
            "transferred": "True",
            "trlicenceagreementid": "1,2345",
            "transferring": "True",
            "valueofgoods": "£0.00",
            "virtualuplift": "100%",
            "virtualnames": "",
            "virtualvalue": "£0.00"
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
workstations int
additionaldeposit currency
additionalproductnames
additionalproductprices
additionalproductquantities
additionalproducttotalprices
addressline1 string 255
addressline2 string 255
addressline3 string 255
agreementno string 12
agreementtype int
approvedby
autorenew boolean
contactid int contactid from Contact
billingpattern
clienttype int clienttypeid from Client Type
companyno
contact int contactid from Contact
contractdiscount
contractlistprice decimal
contractservicenames
contractserviceprices
contractservicequantities
contractservicetotalprices
contractvalue decimal
countersignuser
country
county
createdby string 255 fullname from User
creationdate date
depositheld decimal
directdebit boolean
emailaddress string
enddate date
escalateby
escalationmonths Months within which the price increases.
expansionvalue
faxno
industry int industryid from Industry
items string
leadsource int leadsourceid from Lead Source
licencename string
licencestatus string
licencetemplate int
licencetype
licenceid int Reference to the License
locationname int locationid from Location
mandatorychargesloaded boolean
meetingpackageid int meetingpackageid from Meeting Package
mobileno
monthlygross
monthlyoffice
monthlyofficetax
monthlyservice decimal
monthlyservicetax decimal
monthlytax
monthlytotal
monthlyvirtual decimal
monthlyvirtualtax decimal
newmember boolean
noticegiven boolean
noticeperiod int number of Months
offices string
onboardingemailsent boolean
opportunity int opportunityid from Opportunity
opportunitytype int opportunitytypeid from Opportunity Type
originallicenceagreementid int Appears on licences that have been transferred or renewed.
phoneno string
postcode string 10
quoteid
quoteoptionid
registeredaddressline1 string 255
registeredaddressline2 string 255
registeredaddressline3 string 255
registeredcountry string 255 Countries
registeredcounty string 255 Counties
registeredfaxno
registeredpostcode string 10
registeredphoneno
registeredtown string 255
renewalterm int
renewed boolean
renewing boolean
rentuplift percent
rentschedulemonths string
rentscheduleprices string
rentvalue decimal
rollinglicence boolean Does Licence automatically renew after the term expiration date.
rollingbreakdates boolean
salesperson int userid from User
schedule int scheduletypeid from Schedule Type
serviceuplift percent
servicevalue decimal
services string
showbreakdates boolean
specialterms string 32767
startdate date
licencestatusid
suminsured decimal
suretyaddress1 string 255
suretyaddress2 string 255
suretyaddress3 string 255
suretycontact string 255
suretycountry string 255
suretycounty string 255
suretyemail string 255
suretymobile string 255
suretypostcode string 255
suretyrequired boolean
suretytelephone string 255
suretytown string 255
taxnumber string 255
termmonths int
termdays int
town string 255
transferred boolean
transferring boolean
updatedate date
updatedby string 255 fullname from User
valueofgoods decimal
virtualuplift percent
virtualvalue decimal

Licence Item

https://operate-api.essensys.tech/api/1.0/licenceitem

A Product or Service provided as part of a Licence.

GET https://operate-api.essensys.tech/api/1.0/LicenceItem/13

{
    "response": {
        "id": "630adb63-5234-417f-ae59-f0a229b88962",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 15:29:26",
        "licenceitems": [
            {
                "row_num": "1",
                "autocharge": "false",
                "outputvalue_autocharge": "false",
                "autoescalate": "true",
                "outputvalue_autoescalate": "true",
                "billinadvance": "0",
                "outputvalue_billinadvance": "0",
                "anniversary": "false",
                "outputvalue_anniversary": "false",
                "bundledproduct": "0",
                "mandatorysqftcalc": "0.0000",
                "outputvalue_mandatorysqftcalc": "0.0000",
                "mandatorytovirtualclients": "false",
                "outputvalue_mandatorytovirtualclients": "false",
                "createdby": "Mari-Elena Smith",
                "outputvalue_createdby": "Mari-Elena Smith",
                "creationdate": "2016-07-01T17:07:33+00:00",
                "outputvalue_creationdate": "2016-07-01T17:07:33+00:00",
                "deposit": "0.0000",
                "outputvalue_deposit": "0.0000",
                "depositheld": "1000",
                "outputvalue_depositheld": "1000",
                "depositreturned": "0.0000",
                "outputvalue_depositreturned": "0.0000",
                "discountpercent": "0",
                "outputvalue_discountpercent": "0%",
                "discountamount": "0.0000",
                "outputvalue_discountamount": "0.0000",
                "enddate": "2016-09-30T00:00:00+00:00",
                "outputvalue_enddate": "2016-09-30T00:00:00+00:00",
                "schedule_id": "2",
                "outputvalue_schedule_id": "Monthly",
                "licence": "4",
                "outputvalue_licence": "UK Delivery Team",
                "licenceitemid": "13",
                "outputvalue_licenceitemid": "13",
                "listprice": "1000",
                "outputvalue_listprice": "1000",
                "listpricetotal": "0",
                "outputvalue_listpricetotal": "0",
                "mandatorycharge": "false",
                "outputvalue_mandatorycharge": "false",
                "mandatorychargetype": "0",
                "outputvalue_mandatorychargetype": "0",
                "officesize": "0",
                "outputvalue_officesize": "0",
                "mandatorychargepercentofall": "0",
                "outputvalue_mandatorychargepercentofall": "0%",
                "mandatorypercentofrent": "0",
                "outputvalue_mandatorypercentofrent": "0%",
                "prorata2ndpayment": "false",
                "outputvalue_prorata2ndpayment": "false",
                "product": "74",
                "outputvalue_product": "Room 2",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": "<FROM> - <TO>",
                "outputvalue_referencetext": "<FROM> - <TO>",
                "retainerproduct": "103",
                "outputvalue_retainerproduct": "Deposit",
                "retainerreferencetext": null,
                "outputvalue_retainerreferencetext": null,
                "retainertax": "3",
                "outputvalue_retainertax": "Non-taxable",
                "startdate": "2016-01-01T00:00:00+00:00",
                "outputvalue_startdate": "2016-01-01T00:00:00+00:00",
                "subtotal": "1000",
                "outputvalue_subtotal": "1000",
                "tax": "5",
                "outputvalue_tax": "20% Tax rate",
                "terminated": "false",
                "outputvalue_terminated": "false",
                "total": "1000",
                "outputvalue_total": "1000",
                "totaldeposit": "1000",
                "outputvalue_totaldeposit": "1000",
                "type": "0",
                "outputvalue_type": "0",
                "unitprice": "500",
                "outputvalue_unitprice": "500",
                "updatedate": "2016-07-01T17:09:21+00:00",
                "outputvalue_updatedate": "2016-07-01T17:09:21+00:00",
                "updatedby": "Mari-Elena Smith",
                "outputvalue_updatedby": "Mari-Elena Smith",
                "caneditmandatorycharge": "false",
                "outputvalue_caneditmandatorycharge": "false",
                "workstations": "6",
                "outputvalue_workstations": "6"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
anniversary boolean
autocharge boolean
autoescalate boolean
billinadvance
bundledproduct
caneditmandatorycharge boolean
createdby string 255 fullname from User
creationdate date
deposit decimal
depositheld
depositreturned decimal
discountpercent
discountamount decimal
enddate date
licence int licenceid from Licence
licenceitemid int Reference to the License Item
listprice
listpricetotal
mandatorycharge boolean
mandatorychargetype
mandatorychargepercentofall
mandatorypercentofrent
mandatorysqftcalc decimal
mandatorytovirtualclients boolean
officesize
prorata2ndpayment boolean
product int productid from Product
quantity
referencetext string
retainerproduct int
retainerreferencetext
retainertax
schedule_id int scheduletypeid from Schedule Type
startdate date
subtotal
tax int taxid from Tax
terminated boolean
total currency
totaldeposit currency
type
unitprice currency
updatedate date
updatedby string 255 fullname from User
workstations int

Licence Item Schedule

https://operate-api.essensys.tech/api/1.0/licenceitemschedule

Sets the billing schedule, pricing and discounts for Licence Items.

GET https://operate-api.essensys.tech/api/1.0/licenceitemschedule

{
    "response": {
        "id": "e5258d9c-f791-405c-b763-a6fa1f9c870e",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 15:57:20",
        "licenceitemschedules": [
            {
                "row_num": "1",
                "createdby": "DOMAIN\\mari",
                "outputvalue_createdby": "DOMAIN\\mari",
                "creationdate": "2016-07-01T17:07:33+00:00",
                "outputvalue_creationdate": "2016-07-01T17:07:33+00:00",
                "enddate": "2016-01-31T00:00:00+00:00",
                "outputvalue_enddate": "2016-01-31T00:00:00+00:00",
                "forceprice": "false",
                "outputvalue_forceprice": "false",
                "fullamount": "500",
                "outputvalue_fullamount": "500",
                "invoicenow": "false",
                "outputvalue_invoicenow": "false",
                "invoiced": "true",
                "outputvalue_invoiced": "true",
                "licenceitem": "13",
                "outputvalue_licenceitem": "74",
                "licenceitemscheduleid": "19",
                "outputvalue_licenceitemscheduleid": "19",
                "listprice": "1000",
                "outputvalue_listprice": "1000",
                "discountfromlist": "500",
                "outputvalue_discountfromlist": "500",
                "prorata": "false",
                "outputvalue_prorata": "false",
                "product": "74",
                "outputvalue_product": "Room 2",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "referencetext": "<FROM> - <TO>",
                "outputvalue_referencetext": "<FROM> - <TO>",
                "schedule": "2",
                "outputvalue_schedule": "Monthly",
                "startdate": "2016-01-01T00:00:00+00:00",
                "outputvalue_startdate": "2016-01-01T00:00:00+00:00",
                "unitprice": "500",
                "outputvalue_unitprice": "500",
                "updatedate": "2016-07-01T17:07:33+00:00",
                "outputvalue_updatedate": "2016-07-01T17:07:33+00:00",
                "updatedby": "DOMAIN\\mari",
                "outputvalue_updatedby": "DOMAIN\\mari"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
enddate date
forceprice boolean
fullamount
invoicenow boolean
invoiced boolean
licenceitem int licenceitemid from Licence Item
licenceitemscheduleid int Reference to the Licence Item Schedule
listprice
discountfromlist
prorata boolean
product int productid from Product
quantity
referencetext string 255
schedule int scheduletypeid from Schedule Type
startdate date
unitprice
updatedate date
updatedby string 255 fullname from User

Break Date

https://operate-api.essensys.tech/api/1.0/breakdate

GET https://operate-api.essensys.tech/api/1.0/breakdate/1

curl https://operate-api.essensys.tech/api/1.0/breakdate/1 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "ee39ce98-1ed9-454e-abcf-7cf89340d283",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 10:28:10",
        "breakdates": [
            {
                "breakdate": "2017-10-22T00:00:00",
                "outputvalue_breakdate": "2017-10-22T00:00:00",
                "breakdateid": "1",
                "outputvalue_breakdateid": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-08T10:28:10",
                "outputvalue_creationdate": "2017-08-08T10:28:10",
                "interval": "12",
                "outputvalue_interval": "12",
                "licence": "14",
                "outputvalue_licence": "Agreement version1",
                "updatedate": "2017-08-08T10:28:10",
                "outputvalue_updatedate": "2017-08-08T10:28:10",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ]
    }
}

PUT (Minimum) JSON Body

{
    "breakdates": [
        {
            "breakdate": "22/10/2017",
            "licence": "14"
        }
    ]
}

PUT (Full) JSON Body

{
    "breakdates": [
        {
            "breakdate": "22/10/2017",
            "interval": "12",
            "licence": "14"
        }
    ]
}
Field Type Size Description
breakdate date
breakdateid int Reference to the Break Date
createdby string 255 fullname from User
creationdate date
interval decimal Number of months.
licence int licenceid from Licence
updatedate date
updatedby string 255 fullname from User

Check List Item

https://operate-api.essensys.tech/api/1.0/checklistitem

This is an item of the Licence Checklist which tracks progress towards finalizing a Licence.

GET https://operate-api.essensys.tech/api/1.0/checklistitem/531

curl https://operate-api.essensys.tech/api/1.0/checklistitem/531 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "01cb21f8-a15f-463d-a6f8-40fb4a9c883b",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 13:32:22",
        "lookupchecklistitems": [
            {
                "row_num": "1",
                "checklistitem": "Direct Debit Mandate",
                "outputvalue_checklistitem": "Direct Debit Mandate",
                "checklistitemsid": "531",
                "outputvalue_checklistitemsid": "531",
                "creationdate": "2009-08-13T15:12:52+00:00",
                "outputvalue_creationdate": "2009-08-13T15:12:52+00:00",
                "updatedate": "2009-08-13T15:12:52+00:00",
                "outputvalue_updatedate": "2009-08-13T15:12:52+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
checklistitem string 255
checklistitemsid int Reference to the Check List Item
creationdate date
updatedate date

Licence Check List Item

https://operate-api.essensys.tech/api/1.0/licencechecklistitem

Licences contain a checklist which you can customize and which contains items you need to check before activating a Licence. These typically represent steps to follow before activation.

GET https://operate-api.essensys.tech/api/1.0/licencechecklistitem/2

{
    "response": {
        "id": "5cd85ea5-51c7-46a5-9c30-760d28ec0972",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 13:25:55",
        "licencechecklistitems": [
            {
                "row_num": "1",
                "checked": "false",
                "outputvalue_checked": "false",
                "checkedby": null,
                "outputvalue_checkedby": null,
                "createdby": "Administrator",
                "outputvalue_createdby": "Administrator",
                "creationdate": "2016-12-07T16:41:21+00:00",
                "outputvalue_creationdate": "2016-12-07T16:41:21+00:00",
                "licence": "14",
                "outputvalue_licence": "Agreement version1",
                "checklistitem": "531",
                "outputvalue_checklistitem": "Direct Debit Mandate",
                "licencechecklistitemid": "2",
                "outputvalue_licencechecklistitemid": "2",
                "updatedate": "2016-12-07T16:41:21+00:00",
                "outputvalue_updatedate": "2016-12-07T16:41:21+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
checked boolean
checkedby
createdby string 255 fullname from User
creationdate date
licence int licenseid from Licence
checklistitem int checklistitemsid from Check List Item
licencechecklistitemid int Reference to the Licence Check List Item
updatedate date
updatedby string 255 fullname from User

Licence Member

https://operate-api.essensys.tech/api/1.0/licencemember

A Contact assigned to a Licenced Service.

PUT (Minimum and Full) JSON Body

{
    "licencemembers": [
        {
            "contact": "Item from list",
            "enddate": "22/10/2013",
            "licencememberid": "",
            "licenceitem": "Item from list",
            "startdate": "22/10/2013"
        }
    ]
}
Field Type Size Description
contact int contactid from Contact
createdby string 255 fullname from User
creationdate date
enddate date
licencememberid int Reference to the License Member
licenceitem int licenceitemid from Licence Item
startdate date

Licence Proforma Invoice

https://operate-api.essensys.tech/api/1.0/licenceproformainvoice

A Proforma Invoice generated when issuing a Licence. This invoice provides the customer with information on the Charges applied as part of the Licence. It becomes an Invoice once the Licence has been activated.

GET https://operate-api.essensys.tech/api/1.0/licenceproformainvoice/4

{
    "response": {
        "id": "edac0e5b-e4a0-486f-8714-c487803ae761",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 08:22:54",
        "licenceproformainvoices": [
            {
                "row_num": "1",
                "accountname": "6",
                "outputvalue_accountname": "UK Delivery Team yes",
                "accountref": null,
                "outputvalue_accountref": null,
                "approved": "0",
                "outputvalue_approved": "0",
                "bfwd": "0.0000",
                "outputvalue_bfwd": "0.0000",
                "createdby": "Mari-Elena Smith",
                "outputvalue_createdby": "Mari-Elena Smith",
                "creationdate": "2016-07-01T17:07:33+00:00",
                "outputvalue_creationdate": "2016-07-01T17:07:33+00:00",
                "duedate": "2017-07-27T08:22:54+00:00",
                "outputvalue_duedate": "2017-07-27T08:22:54+00:00",
                "emailaddress": "chelsea.djemal@essensys.tech",
                "outputvalue_emailaddress": "chelsea.djemal@essensys.tech",
                "gross": "0.0000",
                "outputvalue_gross": "0.0000",
                "invoicedate": "2017-07-27T08:22:54+00:00",
                "outputvalue_invoicedate": "2017-07-27T08:22:54+00:00",
                "invoiceid": "4",
                "outputvalue_invoiceid": "4",
                "invoicesort": "UK Delivery Team yes",
                "outputvalue_invoicesort": "UK Delivery Team yes",
                "status": "1",
                "outputvalue_status": "1",
                "invoicetext": null,
                "outputvalue_invoicetext": null,
                "invoicetext1": null,
                "outputvalue_invoicetext1": null,
                "invoicetext2": null,
                "outputvalue_invoicetext2": null,
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "net": "0.0000",
                "outputvalue_net": "0.0000",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "invoicenumber": "4",
                "outputvalue_invoicenumber": "4",
                "tax": "0.0000",
                "outputvalue_tax": "0.0000",
                "updatedate": "2016-07-01T17:09:21+00:00",
                "outputvalue_updatedate": "2016-07-01T17:09:21+00:00",
                "updatedby": "Mari-Elena Smith",
                "outputvalue_updatedby": "Mari-Elena Smith"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
accountname String
accountref
approved
bfwd decimal
createdby string 255 fullname from User
creationdate date
duedate date
emailaddress string
gross decimal
invoicedate date
invoiceid int Reference to the Licence Proforma Invoice
invoicesort string
status int
invoicetext
invoicetext1
invoicetext2
location int locatonid from Location
net decimal
organization int organizationid from Organization
invoicenumber int
tax decimal
updatedate date
updatedby string 255 fullname from User

Licence Proforma Invoice Line

https://operate-api.essensys.tech/api/1.0/licenceproformainvoiceline

A row of a Licence Proforma Invoice, representing a Charge.

GET https://operate-api.essensys.tech/api/1.0/licenceproformainvoiceline/463

{
    "response": {
        "id": "4163071d-ae55-4306-9c63-22b093d25008",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 08:38:37",
        "licenceproformainvoicelines": [
            {
                "row_num": "1",
                "createdby": "Administrator",
                "outputvalue_createdby": "Administrator",
                "creationdate": "2016-12-07T16:41:25+00:00",
                "outputvalue_creationdate": "2016-12-07T16:41:25+00:00",
                "discountfromlist": "200",
                "outputvalue_discountfromlist": "200",
                "from": "2016-12-07T00:00:00+00:00",
                "outputvalue_from": "2016-12-07T00:00:00+00:00",
                "invoicelineid": "463",
                "outputvalue_invoicelineid": "463",
                "licence": "14",
                "outputvalue_licence": "Agreement version1",
                "listprice": "400",
                "outputvalue_listprice": "400",
                "markup": "0",
                "outputvalue_markup": "0",
                "markuptype": "0",
                "outputvalue_markuptype": "0",
                "originalbundle": "0",
                "outputvalue_originalbundle": "0",
                "product": "82",
                "outputvalue_product": "Room 11",
                "productgroup": "24",
                "outputvalue_productgroup": "Office Rent",
                "quantity": "1",
                "outputvalue_quantity": "1",
                "tax": "3",
                "outputvalue_tax": "0",
                "taxrate": "0",
                "outputvalue_taxrate": "0%",
                "to": "2017-01-06T00:00:00+00:00",
                "outputvalue_to": "2017-01-06T00:00:00+00:00",
                "totalprice": "200",
                "outputvalue_totalprice": "200",
                "unitprice": "200",
                "outputvalue_unitprice": "200",
                "updatedate": "2016-12-07T16:41:25+00:00",
                "outputvalue_updatedate": "2016-12-07T16:41:25+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "licenceproformainvoicelines": [
        {
            "from": "22/10/2013",
            "invoicelineid": "",
            "licence": "Item from list",
            "product": "Item from list",
            "to": "22/10/2013"
        }
    ]
}

PUT (Full) JSON Body

{
    "licenceproformainvoicelines": [
        {
            "btchno": "1,2345",
            "bundledproduct": "Item from list",
            "chargesheet": "Item from list",
            "discountfromlist": "£0.00",
            "from": "22/10/2013",
            "invoicelineid": "",
            "licence": "Item from list",
            "listprice": "£0.00",
            "markuptype": "Selected item",
            "newmeterreading": "1,2345",
            "originalbundle": "1,2345",
            "previousmeterreading": "1,2345",
            "product": "Item from list",
            "quantity": "1,2345",
            "referencetext": "",
            "tax": "Item from list",
            "to": "22/10/2013",
            "totalprice": "£0.00",
            "unitprice": "£0.00"
        }
    ]
}
Field Type Size Description
btchno
bundledproduct int
chargesheet int chargesheetid from Charge Sheet
createdby string 255 fullname from User
creationdate date
discountfromlist
from date
invoicelineid int Reference to the Licence Proforma Invoice Line
license int licenceid from License
listprice currency
markup string % or currency amount
markuptype int 1 = % , 2 = Currency Amount
originalbundle
newmeterreading
previousmeterreading
product int productid from Product
productgroup int productgroupid from Product Group
quantity
referencetext
tax int taxid from Tax
taxrate
to date
totalprice currency
unitprice currency
updatedate date
updatedby string 255 fullname from User

Licence Proforma Invoice Summary

https://operate-api.essensys.tech/api/1.0/licenceproformainvoicesummary

A summarized view of invoiced transactions through a Licence Proforma Invoice that only contains totals per Product Group.

GET https://operate-api.essensys.tech/api/1.0/licenceproformainvoicesummary/00000000024

{
    "response": {
        "id": "302016a3-b1c7-4ee9-8457-ad7dbd6cb0a1",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 09:28:18",
        "licenceproformainvoicesummarys": [
            {
                "row_num": "1",
                "createdby": "live",
                "outputvalue_createdby": "live",
                "creationdate": "2017-01-17T21:45:21+00:00",
                "outputvalue_creationdate": "2017-01-17T21:45:21+00:00",
                "invoicesummaryname": "Office Rent",
                "outputvalue_invoicesummaryname": "Office Rent",
                "invoicesummaryid": "00000000024",
                "outputvalue_invoicesummaryid": "00000000024",
                "licenceid": "0",
                "order": "1",
                "outputvalue_order": "1",
                "recordtype": "0",
                "updatedate": "2017-01-17T21:45:21+00:00",
                "outputvalue_updatedate": "2017-01-17T21:45:21+00:00",
                "updatedby": "live",
                "outputvalue_updatedby": "live"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
invoicesummaryname string 255
invoicesummaryid string Reference to the Licence Proforma Invoice Summary
licenceid int licenceid from Licence
order int
recordtype int
updatedate date
updatedby string 255 fullname from User

Licence Proforma Tax Summary

https://operate-api.essensys.tech/api/1.0/licenceproformataxsummary

A summarized view of invoiced tax through a Licence Proforma Invoice.

GET https://operate-api.essensys.tech/api/1.0/licenceproformataxsummary/00001700005

{
    "response": {
        "id": "12733884-5b12-4a39-9d41-5b8c2549d156",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 09:33:59",
        "licenceproformataxsummarys": [
            {
                "row_num": "1",
                "createdby": "live",
                "outputvalue_createdby": "live",
                "creationdate": "2017-06-02T09:16:09+00:00",
                "outputvalue_creationdate": "2017-06-02T09:16:09+00:00",
                "licenceid": "17",
                "outputvalue_licenceid": "New Licence",
                "recordtype": "0",
                "taxrate": "0.2",
                "outputvalue_taxrate": "20%",
                "taxsummaryname": "20% Tax rate",
                "outputvalue_taxsummaryname": "20% Tax rate",
                "taxsummaryid": "00001700005",
                "outputvalue_taxsummaryid": "00001700005",
                "taxtotal": "85.714",
                "outputvalue_taxtotal": "85.714",
                "updatedate": "2017-06-02T09:16:09+00:00",
                "outputvalue_updatedate": "2017-06-02T09:16:09+00:00",
                "updatedby": "live",
                "outputvalue_updatedby": "live"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
licenceid int licenceid from Licence
recordtype int
taxrate decimal
taxsummaryname string 255
taxsummaryid string Reference to the Licence Proforma Tax Summary
taxtotal decimal
updatedate date
updatedby string 255 fullname from User

Licence Status

https://operate-api.essensys.tech/api/1.0/licencestatus

The Licence lifecycle involves the following statuses:

GET https://operate-api.essensys.tech/api/1.0/LicenceStatus/1

{
    "response": {
        "id": "3cf25e58-10ab-4919-abb8-88bc16efd77d",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 11:05:48",
        "licencestatuss": [
            {
                "row_num": "1",
                "createdby": "sa",
                "outputvalue_createdby": "sa",
                "creationdate": "2014-04-30T08:12:13+00:00",
                "outputvalue_creationdate": "2014-04-30T08:12:13+00:00",
                "licencestatusname": "Issued",
                "outputvalue_licencestatusname": "Issued",
                "licencestatusid": "1",
                "outputvalue_licencestatusid": "1",
                "updatedate": "2014-04-30T08:12:13+00:00",
                "outputvalue_updatedate": "2014-04-30T08:12:13+00:00",
                "updatedby": "sa",
                "outputvalue_updatedby": "sa"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
licencestatusname string 255
licencestatusid int Reference to the License Status
updatedate date
updatedby string 255 fullname from User

Movement History

https://operate-api.essensys.tech/api/1.0/movementhistory

A list of Licence renewals, transfers or terminations.

GET https://operate-api.essensys.tech/api/1.0/movementhistory/

{
    "response": {
        "id": "d635e299-46a0-4458-af00-bcc93d267ef7",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 12:00:08",
        "movements": [
            {
                "row_num": "1",
                "account": "6",
                "outputvalue_account": "UK Delivery Team yes",
                "checkinout": "Check In",
                "outputvalue_checkinout": "Check In",
                "createdby": "Mari-Elena Smith",
                "outputvalue_createdby": "Mari-Elena Smith",
                "creationdate": "2016-07-01T17:09:21+00:00",
                "outputvalue_creationdate": "2016-07-01T17:09:21+00:00",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "movementtype": "22",
                "outputvalue_movementtype": "Move In - New Client ",
                "movementid": "1",
                "outputvalue_movementid": "1",
                "office": "true",
                "outputvalue_office": "true",
                "officesize": "0",
                "outputvalue_officesize": "0",
                "product": "74",
                "outputvalue_product": "Room 2",
                "rentalamount": "500",
                "outputvalue_rentalamount": "500",
                "salesperson": "19",
                "outputvalue_salesperson": "Mari-Elena Smith",
                "startdate": "2016-01-01T00:00:00+00:00",
                "outputvalue_startdate": "2016-01-01T00:00:00+00:00",
                "term": "9",
                "outputvalue_term": "9",
                "terminationreason": null,
                "outputvalue_terminationreason": null,
                "updatedate": "2016-08-08T07:53:10+00:00",
                "outputvalue_updatedate": "2016-08-08T07:53:10+00:00",
                "workstations": "6",
                "outputvalue_workstations": "6"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
account int
checkinout string
createdby string 255 fullname from User
creationdate date
location int locationid from Location
movementtype int movementtypeid from Movement Type
movementid int Reference to the Movement History
office boolean
officesize
product int productid from Product
rentalamount
salesperson int
startdate date
term
terminationreason
updatedate date
workstations int

Movement Type

https://operate-api.essensys.tech/api/1.0/movementtype

Determines what type of movement an Account is making. Used when renewing, transferring or terminating a Licence.

GET https://operate-api.essensys.tech/api/1.0/movementype/22

{
    "response": {
        "id": "e3914eea-159f-46fd-a3f7-194976330088",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "27/07/2017 12:07:21",
        "movementtypes": [
            {
                "row_num": "1",
                "creationdate": "2009-05-29T09:39:17+00:00",
                "outputvalue_creationdate": "2009-05-29T09:39:17+00:00",
                "movementtypename": "Move In - New Client ",
                "outputvalue_movementtypename": "Move In - New Client ",
                "movementtypeid": "22",
                "outputvalue_movementtypeid": "22",
                "updatedate": "2009-05-29T09:39:17+00:00",
                "outputvalue_updatedate": "2009-05-29T09:39:17+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
movementtypename string
movementtypeid int Reference to the Movement Type
updatedate date

Non Standard Terms

https://operate-api.essensys.tech/api/1.0/lookupnonstandardterms

Custom terms added to a Licence.

GET https://operate-api.essensys.tech/api/1.0/lookupnonstandardterms/599

{
    "response": {
        "id": "f2492c68-945d-4ffd-8bcb-6caa48e10159",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "15/07/2017 10:05:47",
        "lookupnonstandardtermss": [
            {
                "row_num": "1",
                "creationdate": "2011-01-15T17:31:35+00:00",
                "outputvalue_creationdate": "2011-01-15T17:31:35+00:00",
                "nonstandardterm": "5 Hours Free Meeting Rooms for 3 Months",
                "outputvalue_nonstandardterm": "5 Hours Free Meeting Rooms for 3 Months",
                "nonstandardtermsid": "599",
                "outputvalue_nonstandardtermsid": "599",
                "updatedate": "2011-01-15T17:31:35+00:00",
                "outputvalue_updatedate": "2011-01-15T17:31:35+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum and full) JSON Body

{
    "lookupnonstandardtermss": [
        {
            "nonstandardterm": "This is long text which can go over multiple lines"
        }
    ]
}
Field Type Size Description
creationdate date
nonstandardterm string 32767
nonstandardtermsid int Reference to the non standard term
updatedate date

Termination Reasons

https://operate-api.essensys.tech/api/1.0/lookupterminationresons

Define why a Licence has been terminated.

GET https://operate-api.essensys.tech/api/1.0/lookupterminationresons/587

{
    "response": {
        "id": "9793b3b5-56e2-4ffb-9afd-f53254ce0e22",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 14:14:15",
        "lookupterminationresonss": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:32:07+00:00",
                "outputvalue_creationdate": "2009-08-13T15:32:07+00:00",
                "terminationreason": "Moved to a competitor",
                "outputvalue_terminationreason": "Moved to a competitor",
                "terminationresonsid": "587",
                "outputvalue_terminationresonsid": "587",
                "updatedate": "2009-08-13T15:32:07+00:00",
                "outputvalue_updatedate": "2009-08-13T15:32:07+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
terminationreason string
terminationresonsid int Reference to the Termination Reason
updatedate date

Transfer Reasons

https://operate-api.essensys.tech/api/1.0/lookuptransferreasons

Customizeable reasons why a Licence may be transferred.

GET https://operate-api.essensys.tech/api/1.0/lookuptransferreasons/645

{
    "response": {
        "id": "cc4f6dba-3b85-41ac-878f-850eb0a9b8b6",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "08/08/2017 13:55:14",
        "lookuptransferreasonss": [
            {
                "row_num": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-08T13:53:21+00:00",
                "outputvalue_creationdate": "2017-08-08T13:53:21+00:00",
                "transferreason": "Test 22",
                "outputvalue_transferreason": "Test 22",
                "transferreasonsid": "645",
                "outputvalue_transferreasonsid": "645",
                "updatedate": "2017-08-08T13: 53:21+00:00",
                "outputvalue_updatedate": "2017-08-08T13:53:21+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum & Full) JSON Body

{
    "lookuptransferreasonss": [
        {
            "transferreason": "New Transfer Reason"
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
transferreason string
transferreasonsid int reference to the Transfer Reason
updatedate date
updatedby string 255 fullname from User

Locations

Locations represent the buildings where your Organization is renting space; while Organizations represent the legal entity(ies) that you conduct business under.

Location

https://operate-api.essensys.tech/api/1.0/location

A Location represents your building and is associated to your entire Organization.

Account, Accounts Receivable, Assigned Client Type, Batch Charge Sheet, Booking Charge, Booking Conflict, Calendar, Charge Sheet, Contact, Credit Note, Day Delegate Rate,Device Import, Draft Invoice, Event, Inventory Item, Invoice, Invoice Line, Lead, Licence, Metered Batch Charge Sheet, Movement History, Opportunity, Package, Product, Space Promoter Location, Tracking Device and User can make reference to a locationid.

GET https://operate-api.essensys.tech/api/1.0/Location/1

{
    "response": {
        "id": "2a5c75fa-6db3-4097-a6dd-f47077c9170a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 13:04:11",
        "locations": [
            {
                "row_num": "1",
                "achsortcode": null,
                "outputvalue_achsortcode": null,
                "achaccountname": null,
                "outputvalue_achaccountname": null,
                "achaccountno": null,
                "outputvalue_achaccountno": null,
                "achbankaddress": null,
                "outputvalue_achbankaddress": null,
                "achbankname": null,
                "outputvalue_achbankname": null,
                "activepromoters": "5",
                "outputvalue_activepromoters": "5",
                "activerooms": "4",
                "outputvalue_activerooms": "4",
                "address1": null,
                "outputvalue_address1": null,
                "addressline2": null,
                "outputvalue_addressline2": null,
                "addressline3": null,
                "outputvalue_addressline3": null,
                "approvalpercent": "10",
                "outputvalue_approvalpercent": "1000%",
                "accountno": null,
                "outputvalue_accountno": null,
                "bankaddress": null,
                "outputvalue_bankaddress": null,
                "bankname": null,
                "outputvalue_bankname": null,
                "brand": "0",
                "officehoursend": "2016-12-07T18:00:00+00:00",
                "outputvalue_officehoursend": "2016-12-07T18:00:00+00:00",
                "connectcalllogger": "false",
                "outputvalue_connectcalllogger": "false",
                "country": "United Kingdom",
                "outputvalue_country": "United Kingdom",
                "county": null,
                "outputvalue_county": null,
                "createdby": "UNKNOWN",
                "outputvalue_createdby": "UNKNOWN",
                "creationdate": "2009-08-05T08:40:42+00:00",
                "outputvalue_creationdate": "2009-08-05T08:40:42+00:00",
                "currency": "1",
                "outputvalue_currency": "Pounds Sterling",
                "discontinued": "false",
                "outputvalue_discontinued": "false",
                "email": null,
                "outputvalue_email": null,
                "enableapprovals": "true",
                "outputvalue_enableapprovals": "true",
                "fulladdress": "London<br />United Kingdom",
                "outputvalue_fulladdress": "London<br />United Kingdom",
                "iban": null,
                "outputvalue_iban": null,
                "inactiverooms": "3",
                "outputvalue_inactiverooms": "3",
                "invoiceprefix": "AT-",
                "outputvalue_invoiceprefix": "AT-",
                "officeimageurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_officeimageurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "officeimage2url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_officeimage2url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "officeimage3url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_officeimage3url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "officeimage4url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_officeimage4url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "officeimage5url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_officeimage5url": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "locationuuid": "f6163bf1-fa2a-47e3-b15a-cc08eac2244f",
                "outputvalue_locationuuid": "f6163bf1-fa2a-47e3-b15a-cc08eac2244f",
                "locationid": "1",
                "outputvalue_locationid": "1",
                "hostimageurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_hostimageurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "contactemail": null,
                "outputvalue_contactemail": null,
                "contactmobile": null,
                "outputvalue_contactmobile": null,
                "contactname": null,
                "outputvalue_contactname": null,
                "contacttelephone": null,
                "outputvalue_contacttelephone": null,
                "map": "0,0",
                "outputvalue_map": "0,0",
                "onlinealias": null,
                "outputvalue_onlinealias": null,
                "officehoursstart": "2016-12-07T08:30:00+00:00",
                "outputvalue_officehoursstart": "2016-12-07T08:30:00+00:00",
                "postcode": null,
                "outputvalue_postcode": null,
                "published": "true",
                "outputvalue_published": "true",
                "recordtype": "9",
                "outputvalue_recordtype": "Location",
                "separateaccommadation": "false",
                "outputvalue_separateaccommadation": "false",
                "singlelineaddress": "London United Kingdom",
                "outputvalue_singlelineaddress": "London United Kingdom",
                "locationname": "Aldgate Tower",
                "outputvalue_locationname": "Aldgate Tower",
                "sortcode": null,
                "outputvalue_sortcode": null,
                "swiftcode": null,
                "outputvalue_swiftcode": null,
                "telephone": null,
                "outputvalue_telephone": null,
                "timezone": "35",
                "outputvalue_timezone": "(UTC) Dublin, Edinburgh, Lisbon, London",
                "town": "London",
                "outputvalue_town": "London",
                "updatedate": "2017-06-22T13:35:43+00:00",
                "outputvalue_updatedate": "2017-06-22T13:35:43+00:00",
                "updatedby": "Josephine Smith",
                "outputvalue_updatedby": "Josephine Smith",
                "usesitebankdetails": "false",
                "outputvalue_usesitebankdetails": "false",
                "wifiname": null,
                "outputvalue_wifiname": null,
                "wifipassword": null,
                "outputvalue_wifipassword": null
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
achsortcode string 255
achaccountname string 255
achaccountno string 255
achbankaddress string 4000
achbankname string 255
activepromoters int
activerooms int
address1 string 255
addressline2 string 255
addressline3 string 255
approvalpercent decimal 1 = 100%
accountno string 20
bankaddress string 255
bankname string 255
brand int brandid from Brand
connectcalllogger boolean
country string country from Countries
county string county from Counties
createdby string 255 fullname from User
creationdate date
currency int currencyid from Currency
discontinued boolean
email string
enableapprovals boolean
fulladdress string 4000
iban string 255
inactiverooms int
invoiceprefix string 10
officehoursend date
officeimageurl string
officeimage2url string
officeimage3url string
officeimage4url string
officeimage5url string
locationuuid string 255
locationid int Reference to the location
locationname string
hostimageurl string
contactemail string
contactmobile
contactname
contacttelephone
map string lat, long
onlinealias string 255 Location Name to display on the Portal.
officehoursstart date
postcode string
published boolean
recordtype int recordtypeid from Record Type
separateaccommadation boolean
singlelineaddress string
sortcode string 255
swiftcode string 255
telephone string
timezone int timezoneid from Timezone
town string
updatedate date
updatedby string 255 fullname from User
usesitebankdetails boolean
wifiname string
wifipassword string

Area

https://operate-api.essensys.tech/api/1.0/area

The Area represents the region where your building Location is found.

GET https://operate-api.essensys.tech/api/1.0/area/7

curl https://operate-api.essensys.tech/api/1.0/area/7 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "a2fbe614-efa6-41e4-a46a-86b2f38fb7a3",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "17/07/2017 13:54:50",
        "areas": [
            {
                "row_num": "1",
                "areaname": "North",
                "outputvalue_areaname": "North",
                "areaid": "7",
                "outputvalue_areaid": "7",
                "creationdate": "2009-05-29T09:35:14+00:00",
                "outputvalue_creationdate": "2009-05-29T09:35:14+00:00",
                "updatedate": "2009-05-29T09:35:14+00:00",
                "outputvalue_updatedate": "2009-05-29T09:35:14+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

curl -H 'Authorization: Bearer gAA...X-w' \
     -X PUT \
     -d data='{ "areas": [ { "areaname": "North West Test Area" } ] }' \
     https://operate-api.essensys.tech/api/1.0/area
{
    "areas": [
        {
            "areaname": "West"
        }
    ]
}

DELETE https://operate-api.essensys.tech/api/1.0/area

curl -X DELETE \
 -H "Content-type: application/x-www-form-urlencoded; charset=utf-8" \
 -H "Authorization: Bearer xxxxxx" \
 -d "itemid=13" \
 https://operate-api.essensys.tech/api/1.0/area
{
    "response":{
        "id":"cff97f2f-05b6-40d0-8235-8363ba1dfe2b",
        "status":"OK",
        "providername":"Operate API",
        "datetimeutc":"12/08/2017 15:47:34"
    }
}
Field Type Size Description
areaname string 255
areaid int Reference to the area
creationdate date
updatedate date

Assigned Client Type

https://operate-api.essensys.tech/api/1.0/assignedclienttype

Each Location has Client Types assigned to it in order to ensure all records are correctly stored for the entire Organization.

GET https://operate-api.essensys.tech/api/1.0/assignedclienttype/84

curl https://operate-api.essensys.tech/api/1.0/assignedclienttype/84 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "4e53a240-8635-4b13-b7a7-2dae4feef5af",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "17/07/2017 13:59:46",
        "assignedclienttypes": [
            {
                "row_num": "1",
                "assignedclienttypeid": "84",
                "outputvalue_assignedclienttypeid": "84",
                "clienttype": "3",
                "outputvalue_clienttype": "essensys Ltd - Virtual",
                "creationdate": "2016-09-14T14:05:18+00:00",
                "outputvalue_creationdate": "2016-09-14T14:05:18+00:00",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "organizationname": "essensys Ltd",
                "outputvalue_organizationname": "essensys Ltd",
                "updatedate": "2016-09-14T14:05:18+00:00",
                "outputvalue_updatedate": "2016-09-14T14:05:18+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "assignedclienttypes": [
        {
            "assignedclienttypeid": "",
            "clienttype": "",
            "location": ""
        }
    ]
}
Field Type Size Description
assignedclienttypeid int reference to the assignedclienttype
clienttype int clienttypeid from Client Type
creationdate date
location int locationid from Location
organizationname string 255
updatedate date

Region

https://operate-api.essensys.tech/api/1.0/region

The Region where a building is located.

Meeting Package Region also has a regionid.

GET https://operate-api.essensys.tech/api/1.0/region/

{
    "response": {
        "id": "b09842cf-8abd-40f4-9415-f9d3f610052d",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "25/07/2017 09:39:21",
        "regions": [
            {
                "row_num": "1",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-07-25T09:39:08+00:00",
                "outputvalue_creationdate": "2017-07-25T09:39:08+00:00",
                "regionname": "Region 51",
                "outputvalue_regionname": "Region 51",
                "regionid": "1",
                "outputvalue_regionid": "1",
                "updatedate": "2017-07-25T09:39:08+00:00",
                "outputvalue_updatedate": "2017-07-25T09:39:08+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum and Full) JSON Body

{
    "regions": [
        {
            "regionname": ""
        }
    ]
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
regionname string
regionid int Reference to the Region
updatedate date
updatedby string 255 fullname from User

Opportunities

Opportunity

https://operate-api.essensys.tech/api/1.0/opportunity

An Opportunity is a qualified Lead. This means that you have gained a prospect Account and there is an opportunity for that prospect to become a customer.

Activity History, Licence, Note, Open Task and Task can reference an opportunityid.

GET https://operate-api.essensys.tech/api/1.0/Opportunity/10

{
    "response": {
        "id": "f753e34f-049f-4170-b208-420c32c82f55",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "13/07/2017 17:18:41",
        "opportunitys": [
            {
                "row_num": "1",
                "accountname": "2",
                "agentfee": null,
                "outputvalue_agentfee": null,
                "agreementsigned": "false",
                "outputvalue_agreementsigned": "false",
                "amount": "12000",
                "outputvalue_amount": "12000",
                "broker": "0",
                "agentreference": null,
                "outputvalue_agentreference": null,
                "brokerstatus": "0",
                "outputvalue_brokerstatus": "0",
                "brokerupdated": "false",
                "outputvalue_brokerupdated": "false",
                "brokerfirstname": null,
                "outputvalue_brokerfirstname": null,
                "brokerlastname": null,
                "outputvalue_brokerlastname": null,
                "budget": null,
                "outputvalue_budget": null,
                "campaign_id": "0",
                "checkindate": "2013-04-12T00:00:00+00:00",
                "outputvalue_checkindate": "2013-04-12T00:00:00+00:00",
                "classification_id": "1",
                "outputvalue_classification_id": "Residential",
                "contactfirstname": null,
                "outputvalue_contactfirstname": null,
                "contactlastname": null,
                "outputvalue_contactlastname": null,
                "termmonths": "12",
                "outputvalue_termmonths": "12",
                "contracttype": "0",
                "createdby": "Administrator",
                "outputvalue_createdby": "Administrator",
                "creationdate": "2013-04-12T10:21:07+00:00",
                "outputvalue_creationdate": "2013-04-12T10:21:07+00:00",
                "lostdate": "2013-04-12T00:00:00+00:00",
                "outputvalue_lostdate": "2013-04-12T00:00:00+00:00",
                "daysopen": "1553",
                "outputvalue_daysopen": "1553",
                "enddate": "2014-04-11T00:00:00+00:00",
                "outputvalue_enddate": "2014-04-11T00:00:00+00:00",
                "enquirydate": "2013-04-12T00:00:00+00:00",
                "outputvalue_enquirydate": "2013-04-12T00:00:00+00:00",
                "expansionvalue": "0.0000",
                "outputvalue_expansionvalue": "0.0000",
                "forecast": "false",
                "outputvalue_forecast": "false",
                "leadsource": "Email Campaign",
                "outputvalue_leadsource": "Email Campaign",
                "leadtype": null,
                "outputvalue_leadtype": null,
                "leaddadilead": "false",
                "outputvalue_leaddadilead": "false",
                "locationname": "1",
                "outputvalue_locationname": "Aldgate Tower",
                "locationrequired": null,
                "outputvalue_locationrequired": null,
                "lostreason": null,
                "outputvalue_lostreason": null,
                "opentasks": "0",
                "outputvalue_opentasks": "0",
                "opportunityname": "test",
                "outputvalue_opportunityname": "test",
                "opportunitytype": "13",
                "outputvalue_opportunitytype": "New Customer - Broker",
                "opportunityid": "10",
                "outputvalue_opportunityid": "10",
                "otherneeds": null,
                "outputvalue_otherneeds": null,
                "user_id": "1",
                "outputvalue_user_id": "Administrator ",
                "parkingspaces": "2",
                "outputvalue_parkingspaces": "2",
                "probability": "0",
                "outputvalue_probability": "0%",
                "rate": null,
                "outputvalue_rate": null,
                "recordtype": "83",
                "outputvalue_recordtype": "Opportunity",
                "region_id": "0",
                "salesperson_id": "1",
                "outputvalue_salesperson_id": "Administrator ",
                "size": null,
                "outputvalue_size": null,
                "stage": "-3",
                "outputvalue_stage": "Checked In",
                "startdate": "2013-04-12T00:00:00+00:00",
                "outputvalue_startdate": "2013-04-12T00:00:00+00:00",
                "termdays": "0",
                "outputvalue_termdays": "0",
                "timing": null,
                "outputvalue_timing": null,
                "typeofbusiness": "2",
                "updatedate": "2013-04-12T10:32:59+00:00",
                "outputvalue_updatedate": "2013-04-12T10:32:59+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator",
                "viewed": "false",
                "outputvalue_viewed": "false",
                "webtolead": "false",
                "outputvalue_webtolead": "false",
                "won": "false",
                "outputvalue_won": "false",
                "workstations": "0",
                "outputvalue_workstations": "0"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "opportunitys": [
        {
            "accountname": "12",
            "closedate": "22/10/2017",
            "locationname": "1",
            "opportunityname": "My new op"
        }
    ]
}

PUT (Full) JSON Body

{
    "opportunitys": [
        {
            "accountname": "Item from list",
            "agentfee": "0.00",
            "agreementsigned": "True",
            "amount": "0.00",
            "broker": "Item from list",
            "agentcontact": "Item from list",
            "agentemail": "darren@smith.com",
            "agentreference": "Darren Smith",
            "brokerstatus": "Selected item",
            "brokerupdated": "True",
            "budget": "Darren Smith",
            "campaign_id": "Item from list",
            "checkindate": "22/10/2013",
            "classification_id": "Item from list",
            "closedate": "22/10/2013",
            "contactname": "Item from list",
            "termmonths": "1,2345",
            "contracttype": "Item from list",
            "lostdate": "22/10/2013",
            "deaddate": "22/10/2013 12:23",
            "enddate": "22/10/2013",
            "enquirydate": "22/10/2013 12:23",
            "expansionvalue": "£0.00",
            "forecast": "True",
            "leadsource": "Item from list",
            "leadtype": "Item from list",
            "leaddadilead": "True",
            "locationname": "Item from list",
            "locationrequired": "Darren Smith",
            "lostreason": "Item from list",
            "opportunityname": "Darren Smith",
            "opportunitytype": "Item from list",
            "otherneeds": "This is text area",
            "overturnedbroker": "Item from list",
            "overturnedagentcontact": "Item from list",
            "overturnedagentemail": "darren@domain.com",
            "overturnedagentreference": "Darren Smith",
            "user_id": "Item from list",
            "parkingspaces": "1",
            "rate": "",
            "region_id": "Item from list",
            "salesperson_id": "Item from list",
            "size": "",
            "stage": "Item from list",
            "startdate": "22/10/2013",
            "termdays": "123",
            "timing": "",
            "viewed": "True",
            "webtolead": "True",
            "won": "True",
            "ud_wonnotificationsent": "True",
            "workstations": "1,2345"
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
agentfee currency (decimal for PUT)
agreementsigned boolean
amount currency
broker int accountid from Account
agentreference string 255
brokerstatus int 0 Accepted, 1 Rejected, 2 Overturned, 3 Unallocated, 4 No Match, 9 Not Specified
brokerupdated boolean
brokerfirstname string 255
brokerlastname string 255
budget string 255
campaign_id int campaignid from Email Campaign
checkindate date
classification_id int
contactfirstname string 255
contactlastname string 255
termmonths int
contracttype int
createdby string 255 fullname from User
creationdate date
daysopen int
enddate date
enquirydate date
expansionvalue decimal
forecast boolean
leadsource string leadsource from Lead Source
leadtype int leadtypeid from Lead Type
leaddadilead boolean
locationname int locationid from Location
locationrequired boolean
lostdate date
lostreason int opportuntylostreasonid from Opportunty Lost Reason
opentasks int
opportunityname string 255
opportunitytype int opportunitytypeid from Opportunity Type
opportunityid int Reference to the Opportunity
otherneeds string 4000
user_id int userid from User
parkingspaces int
probability int
rate string 255
recordtype int recordtypeid from Record Type
region_id int regionid from Region
salesperson_id int
size string 255
stage int stageid from Stage
startdate date
termdays int
timing string 255
typeofbusiness int
updatedate date
updatedby string 255 fullname from User
viewed boolean
webtolead boolean
won boolean
workstations int

Contract Type

https://operate-api.essensys.tech/api/1.0/contracttype

Represents the type of contract that an Opportunity may sign. Defaults are: Commercial Lease and Licence.

GET https://operate-api.essensys.tech/api/1.0/contracttype

curl https://operate-api.essensys.tech/api/1.0/contracttype/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "e51971e2-45cf-4197-82a8-07043ebde648",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 16:26:39",
        "contracttypes": [
            {
                "row_num": "1",
                "contracttypename": "Licence ",
                "outputvalue_contracttypename": "Licence ",
                "contracttypeid": "1",
                "outputvalue_contracttypeid": "1",
                "creationdate": "2006-01-24T13:14:02+00:00",
                "outputvalue_creationdate": "2006-01-24T13:14:02+00:00",
                "updatedate": "2006-01-24T13:14:02+00:00",
                "outputvalue_updatedate": "2006-01-24T13:14:02+00:00"
            },
            {
                "row_num": "2",
                "contracttypename": "Commercial Lease ",
                "outputvalue_contracttypename": "Commercial Lease ",
                "contracttypeid": "2",
                "outputvalue_contracttypeid": "2",
                "creationdate": "2006-01-24T13:14:02+00:00",
                "outputvalue_creationdate": "2006-01-24T13:14:02+00:00",
                "updatedate": "2006-01-24T13:14:02+00:00",
                "outputvalue_updatedate": "2006-01-24T13:14:02+00:00"
            }
        ],
        "totalCount": "2"
    }
}
Field Type Size Description
contracttypename string
contracttypeid int Reference to the contract type
creationdate date
updatedate date

Opportunity Lost Reason

https://operate-api.essensys.tech/api/1.0/opportunitylostreason

Explains why an Opportunity has been lost.

GET https://operate-api.essensys.tech/api/1.0/OpportunityLostReason/572

{
    "response": {
        "id": "b69955d9-df9d-4bac-bb96-bb96487cafff",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 09:58:09",
        "opportunitylostreasons": [
            {
                "row_num": "1",
                "creationdate": "2009-08-13T15:32:12+00:00",
                "outputvalue_creationdate": "2009-08-13T15:32:12+00:00",
                "opportuntylostreasonname": "Wrong location ",
                "outputvalue_opportuntylostreasonname": "Wrong location ",
                "opportuntylostreasonid": "572",
                "outputvalue_opportuntylostreasonid": "572",
                "updatedate": "2009-08-13T15:32:12+00:00",
                "outputvalue_updatedate": "2009-08-13T15:32:12+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
opportuntylostreasonname string 255
opportuntylostreasonid int Reference to the Opportunty Lost Reason
updatedate date

Opportunity Type

https://operate-api.essensys.tech/api/1.0/opportunitytype

Provides details on what type of business could be conducted through the Opportunity.

GET https://operate-api.essensys.tech/api/1.0/opportunitytype/11

{
    "response": {
        "id": "3db52863-0ba7-4920-ac6d-51d87f2615a0",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 09:55:03",
        "opportunitytypes": [
            {
                "row_num": "1",
                "creationdate": "2009-05-29T09:35:13+00:00",
                "outputvalue_creationdate": "2009-05-29T09:35:13+00:00",
                "opportunitytypename": "Renewal",
                "outputvalue_opportunitytypename": "Renewal",
                "opportunitytypeid": "11",
                "outputvalue_opportunitytypeid": "11",
                "updatedate": "2009-05-29T09:35:13+00:00",
                "outputvalue_updatedate": "2009-05-29T09:35:13+00:00"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
creationdate date
opportunitytypename string 255
opportunitytypeid int Reference to the Opportunity Type
updatedate date

Stage

https://operate-api.essensys.tech/api/1.0/stage

Represents the progress made towards closing the Opportunity.

GET https://operate-api.essensys.tech/api/1.0/stage/-7

{
    "response": {
        "id": "dceba3ba-1c56-40b8-92be-58efe83a0a89",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "17/07/2017 15:43:50",
        "stages": [
            {
                "row_num": "1",
                "createdby": "sa",
                "outputvalue_createdby": "sa",
                "creationdate": "2014-04-30T08:12:05+00:00",
                "outputvalue_creationdate": "2014-04-30T08:12:05+00:00",
                "disabledelete": "true",
                "outputvalue_disabledelete": "true",
                "stageorder": "999",
                "outputvalue_stageorder": "999",
                "friendlyname": "Viewing Arranged",
                "outputvalue_friendlyname": "Viewing Arranged",
                "hidden": "false",
                "outputvalue_hidden": "false",
                "percentage": "25",
                "outputvalue_percentage": "25%",
                "stagename": "Viewing Arranged",
                "outputvalue_stagename": "Viewing Arranged",
                "stageid": "-7",
                "outputvalue_stageid": "-7",
                "updatedate": "2014-04-30T08:12:05+00:00",
                "outputvalue_updatedate": "2014-04-30T08:12:05+00:00",
                "updatedby": "sa",
                "outputvalue_updatedby": "sa"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
disabledelete boolean
friendlyname string
hidden boolean
percentage int
recordtype int recordtypeid from Record Type
stageid int Reference to the Stage
stagename string
stageorder int
updatedate date
updatedby string 255 fullname from User

Organizations

Organization

https://operate-api.essensys.tech/api/1.0/organization

An Organization represents a legal entity that you conduct business under.

It is linked to all of your records via Client Types and Locations.

Note: A Location represents the buildings where you let space.

Account, Accounts Receivable, Calendar, Client Type, Draft Invoice, Financial Export Log, GL Code, Licence Proforma Invoice can reference an organizationid.

GET https://operate-api.essensys.tech/api/1.0/Organization/1

curl https://operate-api.essensys.tech/api/1.0/Organization/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "8879a71c-d8f2-4c31-8021-e3178cc255b8",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 13:09:13",
        "organizations": [
            {
                "row_num": "1",
                "aba": null,
                "outputvalue_aba": null,
                "achaccountname": null,
                "outputvalue_achaccountname": null,
                "achaccountno": null,
                "outputvalue_achaccountno": null,
                "achbankaddress": null,
                "outputvalue_achbankaddress": null,
                "achbankname": null,
                "outputvalue_achbankname": null,
                "virtualachurl": null,
                "outputvalue_virtualachurl": null,
                "addressline1": "1 Triton Square",
                "outputvalue_addressline1": "1 Triton Square",
                "lgladdress_1": "1 Triton Square",
                "outputvalue_lgladdress_1": "1 Triton Square",
                "addressline2": "Regents Place",
                "outputvalue_addressline2": "Regents Place",
                "lgladdress_3": null,
                "outputvalue_lgladdress_3": null,
                "addressline3": null,
                "outputvalue_addressline3": null,
                "agipassword": null,
                "outputvalue_agipassword": null,
                "accountname": "essensys Current Account",
                "outputvalue_accountname": "essensys Current Account",
                "accountno": "12345678",
                "outputvalue_accountno": "12345678",
                "bankaddress": "NatWest, 159 High Street, Rickmansworth",
                "outputvalue_bankaddress": "NatWest, 159 High Street, Rickmansworth",
                "bankname": "NatWest",
                "outputvalue_bankname": "NatWest",
                "sortcode": "112233",
                "outputvalue_sortcode": "112233",
                "companyno": "5959557",
                "outputvalue_companyno": "5959557",
                "lglcountry": "United Kingdom",
                "outputvalue_lglcountry": "United Kingdom",
                "lglcounty": null,
                "outputvalue_lglcounty": null,
                "createdby": "sa",
                "outputvalue_createdby": "sa",
                "creationdate": "2009-08-05T08:41:01+00:00",
                "outputvalue_creationdate": "2009-08-05T08:41:01+00:00",
                "virtualcreditcardurl": null,
                "outputvalue_virtualcreditcardurl": null,
                "ddfifthdigit": "n",
                "outputvalue_ddfifthdigit": "n",
                "ddfirstdigit": "n",
                "outputvalue_ddfirstdigit": "n",
                "ddforthdigit": "n",
                "outputvalue_ddforthdigit": "n",
                "ddoriginator1": "nn",
                "outputvalue_ddoriginator1": "nn",
                "ddoriginator2": "nn",
                "outputvalue_ddoriginator2": "nn",
                "ddoriginator3": "nn",
                "outputvalue_ddoriginator3": "nn",
                "ddseconddigit": "n",
                "outputvalue_ddseconddigit": "n",
                "ddsixthdigit": "n",
                "outputvalue_ddsixthdigit": "n",
                "ddthirddigit": "n",
                "outputvalue_ddthirddigit": "n",
                "earliestinvoicedate": "1899-12-31T00:00:00+00:00",
                "outputvalue_earliestinvoicedate": "1899-12-31T00:00:00+00:00",
                "exportfiletag": null,
                "outputvalue_exportfiletag": null,
                "fulladdress": "1 Triton Square<br />Regents Place<br />London<br />NW1 3DX<br />United Kingdom",
                "outputvalue_fulladdress": "1 Triton Square<br />Regents Place<br />London<br />NW1 3DX<br />United Kingdom",
                "iban": null,
                "outputvalue_iban": null,
                "logourl": "/spacecontrol/v2/controls/getobjectimage.aspx?operator=Essensys&moduleid=200&fieldid=25307&itemid=1",
                "output_logourl": "/spacecontrol/v2/controls/getobjectimage.aspx?operator=Essensys&moduleid=200&fieldid=25307&itemid=1",
                "merchantid": null,
                "outputvalue_merchantid": null,
                "legalentitycode": null,
                "outputvalue_legalentitycode": null,
                "organizationname": "essensys Ltd",
                "outputvalue_organizationname": "essensys Ltd",
                "organizationid": "1",
                "outputvalue_organizationid": "1",
                "paymentprocessor": "Stripe",
                "outputvalue_paymentprocessor": "Stripe",
                "lglpostcode": "NW1 3DX",
                "outputvalue_lglpostcode": "NW1 3DX",
                "processorcurrencycode": "GBP",
                "outputvalue_processorcurrencycode": "GBP",
                "enablerecurringpayments": "false",
                "outputvalue_enablerecurringpayments": "false",
                "processorpassword": null,
                "outputvalue_processorpassword": null,
                "processorsignature": null,
                "outputvalue_processorsignature": null,
                "processorusesandbox": "true",
                "outputvalue_processorusesandbox": "true",
                "processoruserid": "sk_test_WzUInabI3itxFQvacMOK2pjo",
                "outputvalue_processoruserid": "sk_test_WzUInabI3itxFQvacMOK2pjo",
                "recordtype": "0",
                "singlelineaddress": "1 Triton Square,Regents Place London NW1 3DX United Kingdom",
                "outputvalue_singlelineaddress": "1 Triton Square,Regents Place London NW1 3DX United Kingdom",
                "swiftcode": null,
                "outputvalue_swiftcode": null,
                "vatnumber": "12345678GB",
                "outputvalue_vatnumber": "12345678GB",
                "lgltown": "London",
                "outputvalue_lgltown": "London",
                "updatedate": "2017-04-24T16:56:41+00:00",
                "outputvalue_updatedate": "2017-04-24T16:56:41+00:00",
                "updatedby": "Ben Smith",
                "outputvalue_updatedby": "Ben Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "organizations": [
        {
            "organizationname": ""
        }
    ]
}

PUT (Full) JSON Body

{
    "organizations": [
        {
            "aba": "",
            "achaccountname": "",
            "achaccountno": "",
            "achbankaddress": "",
            "achbankname": "",
            "virtualachurl": "http://www.spacedadi.com",
            "lgladdress_1": "",
            "addressline1": "",
            "addressline2": "",
            "lgladdress_3": "",
            "addressline3": "",
            "agipassword": "",
            "accountname": "",
            "accountno": "",
            "bankaddress": "",
            "bankname": "",
            "sortcode": "",
            "companyno": "",
            "lglcountry": "",
            "lglcounty": "",
            "virtualcreditcardurl": "http://www.spacedadi.com",
            "ddoriginator1": "",
            "ddoriginator2": "",
            "ddoriginator3": "",
            "earliestinvoicedate": "22/10/2013",
            "exportfiletag": "",
            "iban": "",
            "logo": "",
            "merchantid": "",
            "legalentitycode": "",
            "organizationname": "",
            "othercontactname": "",
            "paymentprocessor": "",
            "lglpostcode": "",
            "processorcurrencycode": "",
            "enablerecurringpayments": "True",
            "processorpassword": "",
            "processorsignature": "",
            "processorusesandbox": "True",
            "processoruserid": "",
            "swiftcode": "",
            "vatnumber": "",
            "phoneno": "+44 845 303 1000",
            "lgltown": "",
            "website": "http://www.spacedadi.com"
        }
    ]
}
Field Type Size Description
aba string 255
achaccountname string 255
achaccountno string 255
achbankaddress string 255
addressline1 string 40
addressline2 string 40
addressline3 string 30
agipassword string 255
accountname string 255
accountno string 20
bankname string 255
createdby string 255 fullname from User
creationdate date
companyno string 50
ddfifthdigit string 1
ddfirstdigit string 1
ddforthdigit string 1
ddoriginator1 string 2
ddoriginator2 string 2
ddoriginator3 string 2
ddseconddigit string 1
ddsixthdigit string 1
ddthirddigit string 1
earliestinvoicedate date
enablerecurringpayments boolean
exportfiletag string 20
fulladdress string 4000
iban string 255
lgladdress_1 string 40
lgladdress_3 string 30
lglcountry string 255 from Countries
lglcounty string 30 from Counties
lglpostcode string 20
lgltown string 30
logourl string 255
legalentitycode string 255
merchantid string 255
organizationname string 255 displayname for the Organization
organizationid int Reference to the Organization
paymentprocessor string 255
processorcurrencycode string 255 currencycode from Currency
processorpassword string 255
processorsignature string 255
processorusesandbox boolean
processoruserid string 255
recordtype int recordtypeid from Record Type
singlelineaddress string 4000
sortcode string 20
swiftcode string 255
vatnumber string 20
virtualachurl string 255
virtualcreditcardurl string 255
updatedate date
updatedby string 255 fullname from User

Client Type

https://operate-api.essensys.tech/api/1.0/clienttype

Client Types define your members based on their space and service use. Default types are: Resident, Club Member or Virtual. You can configure your own.

GET https://operate-api.essensys.tech/api/1.0/clienttype/1

curl https://operate-api.essensys.tech/api/1.0/clienttype/1 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "d4c846bb-eb0b-4fb8-9b04-075c03e9b8b6",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 10:52:50",
        "clienttypes": [
            {
                "row_num": "1",
                "chargeexternalrates": "false",
                "outputvalue_chargeexternalrates": "false",
                "clienttypeandorganization": "essensys Ltd - Residential",
                "outputvalue_clienttypeandorganization": "essensys Ltd - Residential",
                "clienttypename": "Residential",
                "outputvalue_clienttypename": "Residential",
                "clienttypeid": "1",
                "outputvalue_clienttypeid": "1",
                "createdby": "RJMETIS\\seby",
                "outputvalue_createdby": "RJMETIS\\seby",
                "creationdate": "2010-10-01T10:23:18+00:00",
                "outputvalue_creationdate": "2010-10-01T10:23:18+00:00",
                "organization": "1",
                "outputvalue_organization": "essensys Ltd",
                "webrescreditcard": "false",
                "outputvalue_webrescreditcard": "false",
                "residentialclassification": "true",
                "outputvalue_residentialclassification": "true",
                "updatedate": "2014-08-20T16:01:57+00:00",
                "outputvalue_updatedate": "2014-08-20T16:01:57+00:00",
                "updatedby": "Administrator",
                "outputvalue_updatedby": "Administrator",
                "useinvoiceprefix": "false",
                "outputvalue_useinvoiceprefix": "false",
                "virtualclassification": "false",
                "outputvalue_virtualclassification": "false"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
chargeexternalrates boolean
clienttypeandorganization string
clienttypename string
clienttypeid int Reference to the Client Type
createdby string 255 fullname from User
creationdate date
organization int organizationid from Organization
webrescreditcard boolean
residentialclassification boolean
updatedate date
updatedby string 255 fullname from User
useinvoiceprefix boolean
virtualclassification boolean

GL Code

https://operate-api.essensys.tech/api/1.0/glcode

A General Ledger Code associated to each product and used for accounting purposes. Ensure you add GL Codes if you export data to third party apps.

GET https://operate-api.essensys.tech/api/1.0/glcode/7

curl https://operate-api.essensys.tech/api/1.0/glcode/7 \
 -H 'Authorization: Bearer gAA...X-w'
{
    "response": {
        "id": "faad51a9-2a44-4392-a7e0-cbe33a3dcdf4",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 16:05:48",
        "glcodes": [
            {
                "row_num": "1",
                "clientretainer": "false",
                "outputvalue_clientretainer": "false",
                "controlaccount": "1",
                "outputvalue_controlaccount": "1",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "creationdate": "2005-06-06T16:20:22+00:00",
                "outputvalue_creationdate": "2005-06-06T16:20:22+00:00",
                "disabledelete": "1",
                "outputvalue_disabledelete": "1",
                "forfeitcode": "false",
                "outputvalue_forfeitcode": "false",
                "glcodename": "Deferred Income",
                "outputvalue_glcodename": "Deferred Income",
                "glcodeid": "7",
                "outputvalue_glcodeid": "7",
                "gocardless": "false",
                "outputvalue_gocardless": "false",
                "gocardlessfee": "false",
                "outputvalue_gocardlessfee": "false",
                "organization": "0",
                "retainerliability": "false",
                "outputvalue_retainerliability": "false",
                "updatedate": "2005-06-06T16:20:22+00:00",
                "outputvalue_updatedate": "2005-06-06T16:20:22+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "glcodes": [
        {
            "glcodename": "",
            "organization": "Item from list"
        }
    ]
}

PUT (Full) JSON Body

{
    "glcodes": [
        {
            "clientretainer": "True",
            "disabledelete": "True",
            "forfeitcode": "True",
            "glcode": "",
            "glcodename": "",
            "gocardless": "True",
            "gocardlessfee": "True",
            "organization": "Item from list",
            "retainerliability": "True"
        }
    ]
}
Field Type Size Description
clientretainer boolean
controlaccount int
createdby string 255 fullname from User
creationdate date
disabledelete boolean
forfeitcode boolean
glcodename string
glcodeid int Reference to the GL Code
gocardless boolean
gocardlessfee boolean
organization int organizationid from Organization
retainerliability boolean
updatedate date
updatedby string 255 fullname from User

Payments

Payments represent transactions made by other business entities (your Accounts towards your Organization).

Payments need a Payment Type (method) and can be made within a Payment Term if Accounts can pay within a certain timeframe after the Invoice date.

Payment

https://operate-api.essensys.tech/api/1.0/payment

Payments are received by your Organization as a result of Invoices or client Charges Payments are added via Accounts Receivable.

GET https://operate-api.essensys.tech/api/1.0/payment/1100

{
    "response": {
        "id": "5ed33547-3f6b-41e2-8ddd-c059764bb1e2",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "03/08/2017 09:49:56",
        "payments": [
            {
                "row_num": "1",
                "accountname": "2",
                "createdby": "Paul Smith",
                "outputvalue_createdby": "Paul Smith",
                "creationdate": "2017-08-03T09:49:46+00:00",
                "outputvalue_creationdate": "2017-08-03T09:49:46+00:00",
                "glcode": "1000",
                "includeswithholdingtax": "false",
                "outputvalue_includeswithholdingtax": "false",
                "paymentdate": "2013-10-22T00:00:00+00:00",
                "outputvalue_paymentdate": "2013-10-22T00:00:00+00:00",
                "paymentid": "1100",
                "outputvalue_paymentid": "1100",
                "paymenttype": "1",
                "outputvalue_paymenttype": "Cheque",
                "reference": "Test",
                "outputvalue_reference": "Test",
                "updatedate": "2017-08-03T09:49:46+00:00",
                "outputvalue_updatedate": "2017-08-03T09:49:46+00:00",
                "updatedby": "Paul Smith",
                "outputvalue_updatedby": "Paul Smith"
            }
        ],
        "totalCount": "1"
    }
}

PUT (minimum) JSON Body

{
    "payments": [
        {
            "accountname": "Item from list",
            "glcode": "Item from list",
            "paymentdate": "22/10/2013",
            "paymenttype": "Item from list",
            "reference": ""
        }
    ]
}

PUT (full) JSON Body

{
    "payments": [
        {
            "accountname": "Item from list",
            "allocateto": "",
            "amountpaid": "£0.00",
            "comments": "This is very long text which can go over multiple lines",
            "paymentcurrencycode": "Item from list",
            "paymentexchangerate": "12345",
            "glcode": "Item from list",
            "includeswithholdingtax": "True",
            "paymentdate": "22/10/2013",
            "paymenttype": "Item from list",
            "reference": ""
        }
    ]
}
Field Type Size Description
accountname int accountid from Account
allocateto string 32767
amountpaid currency
comments string
glcode int glcodeid from GL Code
includeswithholdingtax boolean
paymentcurrencycode int currencyid from Currency
paymentexchangerate decimal
paymentdate date
paymenttype int paymenttypeid from Accounts Receivable Payment Type
reference string 255

Payment Term

https://operate-api.essensys.tech/api/1.0/paymentterm

Represents how much time an Account has between their billing date and Invoice due date.

GET https://operate-api.essensys.tech/api/1.0/PaymentTerm/1

{
    "response": {
        "id": "5fe60998-bfdb-4a5b-878f-e4882e631db5",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 15:07:38",
        "paymentterms": [
            {
                "row_num": "1",
                "createdby": "sa",
                "outputvalue_createdby": "sa",
                "creationdate": "2002-07-24T16:29:21+00:00",
                "outputvalue_creationdate": "2002-07-24T16:29:21+00:00",
                "daysdue": "14",
                "outputvalue_daysdue": "14",
                "description": "to be paid within 14 days",
                "outputvalue_description": "to be paid within 14 days",
                "paymenttermname": "14 Days",
                "outputvalue_paymenttermname": "14 Days",
                "paymenttermid": "1",
                "outputvalue_paymenttermid": "1",
                "updatedate": "2002-07-24T16:29:21+00:00",
                "outputvalue_updatedate": "2002-07-24T16:29:21+00:00",
                "updatedby": "sa",
                "outputvalue_updatedby": "sa"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
creationdate date
daysdue int
description string 255
paymenttermname string 255
paymenttermid int reference to the Payment Term
updatedate date
updatedby string 255 fullname from User

Payment Type

https://operate-api.essensys.tech/api/1.0/paymenttype

The payment methods used with Accounts Receivable.

GET https://operate-api.essensys.tech/api/1.0/paymenttype/3

{
    "response": {
        "id": "eb5212ac-d159-4096-b23e-ad0c25e7b184",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 16:18:27",
        "paymenttypes": [
            {
                "row_num": "1",
                "createdby": "sa",
                "outputvalue_createdby": "sa",
                "currency": "0",
                "incbacstransfer": "false",
                "outputvalue_incbacstransfer": "false",
                "invoicetext": "will be collected from your credit card on the xxx of the month",
                "outputvalue_invoicetext": "will be collected from your credit card on the xxx of the month",
                "paymenttypename": "Credit card",
                "outputvalue_paymenttypename": "Credit card",
                "paymenttypeid": "3",
                "outputvalue_paymenttypeid": "3",
                "updatedate": "2005-06-06T16:19:56+00:00",
                "outputvalue_updatedate": "2005-06-06T16:19:56+00:00",
                "updatedby": "sa",
                "outputvalue_updatedby": "sa"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
createdby string 255 fullname from User
currency int currencyid from Currency
incbacstransfer boolean
invoicetext string 37676
paymenttypename string 255
paymenttypeid int Reference to the Payment Type
updatedate date
updatedby string 255 fullname from User

Portal

Overview

The Portal allows members to join an Operator’s community, have their own Profile, book meeting rooms and Event, manage payment methods and pay for their Invoice. The Portal can be customized with a Portal Page.

Announcement

https://operate-api.essensys.tech/api/1.0/announcement/

Broadcast important messages and updates to your members. This is a Portal Specific feature.

GET https://operate-api.essensys.tech/api/1.0/Announcement/1

curl https://operate-api.essensys.tech/api/1.0/Announcement/1 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "f101d636-598f-4d51-bb17-26e2c726a5ab",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "12/07/2017 14:01:29",
        "announcements": [
            {
                "row_num": "1",
                "announcementname": "Welcome to the new Portal",
                "outputvalue_announcementname": "Welcome to the new Portal",
                "description": "Welcome to the new Portal!",
                "outputvalue_description": "Welcome to the new Portal!",
                "announcementid": "1",
                "outputvalue_announcementid": "1",
                "createdby": "admin",
                "outputvalue_createdby": "admin",
                "location": "0",
                "publishdate": "2016-09-07T12:13:00+00:00",
                "outputvalue_publishdate": "2016-09-07T12:13:00+00:00",
                "updatedate": "2016-09-07T12:14:25+00:00",
                "outputvalue_updatedate": "2016-09-07T12:14:25+00:00",
                "updatedby": "admin",
                "outputvalue_updatedby": "admin"
            }
        ],
        "totalCount": "1"
    }
}
Field Type Size Description
announcementname string
description string
announcementid int reference to the announcement
createdby string fullname from User
location int
publishdate date
updatedate date
updatedby string fullname from User

Attendee

https://operate-api.essensys.tech/api/1.0/eventattendee

This is a person who has registered for an Event. Attendees are created manually or automatically upon registration.

attendeeid is not referenced by any other items.

GET https://operate-api.essensys.tech/api/1.0/eventattendee/1

curl https://operate-api.essensys.tech/api/1.0/eventattendee/1 \
     -H 'Authorization: Bearer gAAAAIsQFg_Nkh....fevnYzautrfLDg'
{
    "response": {
        "id": "624d0702-efe1-4f77-80de-14ce877db5b9",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "18/07/2017 16:54:24",
        "eventattendees": [
            {
                "row_num": "1",
                "firstname": "Mari-Elena",
                "outputvalue_firstname": "Mari-Elena",
                "feepaid": "0.0000",
                "outputvalue_feepaid": "0.0000",
                "attendeename": "Mari-Elena Smith",
                "outputvalue_attendeename": "Mari-Elena Smith",
                "attendeeid": "1",
                "outputvalue_attendeeid": "1",
                "company": null,
                "outputvalue_company": null,
                "createdby": "portal",
                "outputvalue_createdby": "portal",
                "creationdate": "2016-09-07T12:19:45+00:00",
                "outputvalue_creationdate": "2016-09-07T12:19:45+00:00",
                "registereddate": "2016-09-07T00:00:00+00:00",
                "outputvalue_registereddate": "2016-09-07T00:00:00+00:00",
                "email": "mari-elena.smith@essensys.tech",
                "outputvalue_email": "mari-elena.smith@essensys.tech",
                "event": "144",
                "outputvalue_event": "JFF",
                "lastname": "Smith",
                "outputvalue_lastname": "Smith",
                "phone": null,
                "outputvalue_phone": null,
                "updatedate": "2016-09-07T12:19:45+00:00",
                "outputvalue_updatedate": "2016-09-07T12:19:45+00:00",
                "updatedby": "portal",
                "outputvalue_updatedby": "portal"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "eventattendees": [
        {
            "attendeeid": "Darren Smith",
            "event": "Item from list"
        }
    ]
}

PUT (Full) JSON Body

{
    "eventattendees": [
        {
            "firstname": "Darren",
            "feepaid": "£0.00",
            "attendeeid": "Darren Smith",
            "company": "",
            "registereddate": "22/10/2013 12:23",
            "email": "darren@domain.com",
            "event": "Item from list",
            "lastname": "Smith",
            "phone": "+44 123 456 7890"
        }
    ]
}
Field Type Size Description
attendeeid int Reference to the Attendee
attendeename string 255
company string 255
createdby string 255 fullname from User
creationdate date
email string
event int eventid from Event
firstname string 255
feepaid decimal
lastname string 255
phone string
registereddate date
updatedate date
updatedby string 255 fullname from User

Event

https://operate-api.essensys.tech/api/1.0/event

Events take place at your location (or online). Operate allows adding events and lets members register for them using the Portal.

Attendee and Shout Out can reference an eventid.

GET https://operate-api.essensys.tech/api/1.0/event/144

{
    "response": {
        "id": "35da0fa0-31ca-41c3-84dc-f03163c1665a",
        "status": "OK",
        "providername": "Operate API",
        "datetimeutc": "20/07/2017 15:47:55",
        "events": [
            {
                "row_num": "1",
                "allowmultipleattendees": "true",
                "outputvalue_allowmultipleattendees": "true",
                "eventlink": "<a href='{portalurl}/events.aspx?EventName=JFF&EventId=144' target='new'>Book Event</a>",
                "outputvalue_eventlink": "<a href='' target='new'>Book Event</a>",
                "eventbookbutton": "",
                "outputvalue_eventbookbutton": "",
                "creationdate": "2016-09-07T12:18:08+00:00",
                "outputvalue_creationdate": "2016-09-07T12:18:08+00:00",
                "description": "JFF",
                "outputvalue_description": "JFF",
                "discontinued": "false",
                "outputvalue_discontinued": "false",
                "emailnotifyfrom": "[EVENTOWNEREMAIL]",
                "outputvalue_emailnotifyfrom": "[EVENTOWNEREMAIL]",
                "emailsendto": "[EMAIL]",
                "outputvalue_emailsendto": "[EMAIL]",
                "enablenonmemberpricing": "false",
                "outputvalue_enablenonmemberpricing": "false",
                "eventname": "JFF",
                "outputvalue_eventname": "JFF",
                "owneremail": "mari-elena.smith@essensys.tech",
                "outputvalue_owneremail": "mari-elena.smith@essensys.tech",
                "eventpictureurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "output_eventpictureurl": "/SPACECONTROL/v2/Controls/img/no_image.jpg",
                "eventid": "144",
                "outputvalue_eventid": "144",
                "location": "1",
                "outputvalue_location": "Aldgate Tower",
                "capacity": "60",
                "outputvalue_capacity": "60",
                "unitprice": "0.0000",
                "outputvalue_unitprice": "0.0000",
                "emailmessage": "Dear&nbsp;[FIRSTNAME]<br />\r\n<br />\r\nThanks for registering on&nbsp;[EVENTTITLE]",
                "outputvalue_emailmessage": "Dear&nbsp;[FIRSTNAME]<br />\r\n<br />\r\nThanks for registering on&nbsp;[EVENTTITLE]",
                "recordtype": "10309",
                "outputvalue_recordtype": "Product",
                "startdate": "2016-09-09T00:00:00+00:00",
                "outputvalue_startdate": "2016-09-09T00:00:00+00:00",
                "emailsubject": "Congrats uve registered",
                "outputvalue_emailsubject": "Congrats uve registered",
                "updatedate": "2016-09-07T12:18:08+00:00",
                "outputvalue_updatedate": "2016-09-07T12:18:08+00:00"
            }
        ],
        "totalCount": "1"
    }
}

PUT (Minimum) JSON Body

{
    "events": [
        {
            "eventname": "",
            "eventid": "",
            "location": "Item from list",
            "mergefield": "Item from list"
        }
    ]
}

PUT (Full) JSON Body

{
    "events": [
        {
            "allowmultipleattendees": "True",
            "description": "This is very long text which can go over multiple lines",
            "discontinued": "True",
            "emailnotifyfrom": "darren@domain.com",
            "emailsendto": "Darren Smith",
            "enablenonmemberpricing": "True",
            "enddate": "22/10/2013 12:23",
            "eventname": "Darren Smith",
            "owneremail": "darren@domain.com",
            "eventpicture": "",
            "eventid": "Darren Smith",
            "location": "Item from list",
            "capacity": "1,2345",
            "unitprice": "£0.00",
            "mergefield": "Item from list",
            "emailmessage": {
                "strong": "html"
            },
            "nonmemberunitprice": "£0.00",
            "startdate": "22/10/2013 12:23",
            "emailsubject": "Darren Smith"
        }
    ]
}
Field Type Size Description
allowmultipleattendees boolean
eventlink string
eventbookbutton
capacity
creationdate date
description string
discontinued boolean
emailmessage string
emailnotifyfrom string
emailsendto string
emailsubject string
enablenonmemberpricing boolean
eventname string
owneremail string
eventpictureurl string
eventid int Reference to the Event
location int locationid from Location
unitprice decimal
recordtype int recordtypeid from Record Type
startdate date
updatedate date

Portal Login

https://operate-api.essensys.tech/api/1.0/portallogons

Stores Portal User Login information.

PUT (Minimum) JSON Body

{
    "portallogonss": [
        {
            "logonid": "",
            "username": ""
        }
    ]
}

PUT (Full) JSON Body

{
    "portallogonss": [
        {
            "firstname": "Darren",
            "lastname": "Smith",
            "logindate": "22/10/2013 12:23",
            "logonid": "",
            "username": ""
        }
    ]
}
Field Type Size Description
firstname string 255
lastname string 255
logindate date
logonid
username string 255

Portal Page

https://operate-api.essensys.tech/api/1.0/portalpage

Custom HTML Pages that can be added to the Portal.

PUT (Minimum) JSON Body

{
    "portalpages": [
        {
            "modulename": "Item from list",
            "portalpagename": "",
            "portalpageid": ""