Skip to content
/
Check if site exists

Elevate Customer and Sites API (1.41)

Customer and Site Management

Provides read & write access to customer and site entities.

Definitions

  • Customer - the primary entity within Elevate to represent the person or company who is contracted with a Contract Owner for the provision of products or services
  • Site - within each Customer, there are one or more Sites to represent the physical locations of the Customer

Products and services are associated to the Sites as inventory items. Sites can be setup to receive invoices individually or to consolidate invoices to a particular site or sites

Download OpenAPI description
billing-rest-customer.json
billing-rest-customer.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

customers

Customers represent the person or company contracted to receive products or services

Operations

sites

Sites represent the physical locations for each Customer

Operations

Get a list of available sites

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
customerIdstring(IdFilterParam)

Filter by customer

Example: customerId=0
siteNamestring(StringFilterParam)

Filter by site name

Example: siteName=xyz | in:x,y | like:xyz
siteReferencestring(StringFilterParam)

Filter by site reference

Example: siteReference=xyz | in:x,y | like:xyz
createdDatestring(DateTimeFilterParam)

Filter by created date/time

Example: createdDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
updatedDatestring(DateTimeFilterParam)

Filter by updated date/time

Example: updatedDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
mandateStatusstring(StringFilterParam)

Filter by mandate status

Example: mandateStatus=xyz | in:x,y | like:xyz
mandateCreatedDatestring(DateFilterParam)

Filter by mandate created date

Example: mandateCreatedDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
mandateUpdatedDatestring(DateFilterParam)

Filter by mandate updated date

Example: mandateUpdatedDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
mandateReferencestring(StringFilterParam)

Filter by mandate reference

Example: mandateReference=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/sites?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&createdDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&updatedDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&mandateStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&mandateCreatedDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&mandateUpdatedDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&mandateReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Site identifier

Example: 1
customerIdinteger(int64)required

Customer identifier - set to 0 when creating a new customer

Example: 0
siteNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site name

siteReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site reference

startDatestring(date)required

Site start date

endDatestring(date)

Site end date

createdDatestring(date-time)read-only

Site created date

updatedDatestring(date-time)read-only

Site updated date

siteAddressobject(Address)required
siteAddress.​idinteger(int64)read-only

Internal identifier for address entry

Example: 1
siteAddress.​businessNamestring[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Business name

siteAddress.​address1string[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Address line 1

siteAddress.​address2string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 2

siteAddress.​address3string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 3

siteAddress.​townstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Town

siteAddress.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

siteAddress.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

siteAddress.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
siteInvoiceDetailsobject(SiteInvoiceDetails)

Invoice details if this site should receive invoices

siteIdReceivingInvoiceinteger(int64)

Identifier of another site that receives the invoices if no invoice details provided for this site

Example: 1
siteContactsArray of objects(ContactDetails)non-emptyrequired
siteContacts[].​idinteger(int64)read-only

Contact identifier

Example: 1
siteContacts[].​contactNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Contact name

siteContacts[].​contactTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

siteContacts[].​contactAlternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact alternative telephone number

siteContacts[].​contactEmailAddressstring(EmailAddress)<= 255 characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...

Email address

siteContacts[].​contactRolestring(ContactRole)required

Contact Role

Enum"ACCOUNTS""TECHNICAL""SALES""GENERAL"
siteContacts[].​receiveInvoiceBystring(ReceiveInvoiceBy)

Receive invoice by email, post or both? Required when contactNameToAppearOnInvoice is set to true

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveInvoiceSummaryBystring(ReceiveInvoiceSummaryBy)

Receive invoice summary by email, post or both?

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveElectronicSummaryReportsboolean

Will receive electronic summary reports

siteContacts[].​emailSuspendedboolean

Whether the contact is unable to receive emails

Default false
siteContacts[].​contactNameToAppearOnInvoiceboolean

Only 1 contact per site can be set to true. If unspecified, this will be defaulted to the 1st contact. If specified for a different contact, it will be set to false for the previous one

Default false
siteContacts[].​receiveEmailFraudAlertboolean

Will receive a fraud alert by email

Default false
siteContacts[].​receiveSmsFraudAlertboolean

Will receive a fraud alert by SMS

Default false
repaymentPlanAmountnumber(decimal)[ 1 .. 100000 ]

Repayment plan period amount in major currency (e.g pounds/dollars/euros)

repaymentPlanRemainingPeriodsinteger(int64)[ 0 .. 240 ]

repayment plan remaining periods (typically in months)

Example: 0
assignedCustomFieldsArray of objects(AssignedCustomField)
Example: [{"customFieldDefinitionId":102,"label":"Customer Tier","value":"Gold"}]
]
Response
application/json
[
  {
    "id": 1,
    "customerId": 0,
    "siteName": "string",
    "siteReference": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "siteAddress": { … },
    "siteInvoiceDetails": { … },
    "siteIdReceivingInvoice": 1,
    "siteContacts": [ … ],
    "repaymentPlanAmount": 1,
    "repaymentPlanRemainingPeriods": 0,
    "assignedCustomFields": [ … ]
  }
]

Create a new site

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New site

customerIdinteger(int64)required

Customer identifier - set to 0 when creating a new customer

Example: 0
siteNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site name

siteReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site reference

startDatestring(date)required

Site start date

endDatestring(date)

Site end date

siteAddressobject(Address)required
siteAddress.​businessNamestring[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Business name

siteAddress.​address1string[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Address line 1

siteAddress.​address2string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 2

siteAddress.​address3string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 3

siteAddress.​townstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Town

siteAddress.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

siteAddress.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

siteAddress.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
siteInvoiceDetailsobject(SiteInvoiceDetails)

Invoice details if this site should receive invoices

siteIdReceivingInvoiceinteger(int64)

Identifier of another site that receives the invoices if no invoice details provided for this site

Example: 1
siteContactsArray of objects(ContactDetails)non-emptyrequired
siteContacts[].​contactNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Contact name

siteContacts[].​contactTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

siteContacts[].​contactAlternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact alternative telephone number

siteContacts[].​contactEmailAddressstring(EmailAddress)<= 255 characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...

Email address

siteContacts[].​contactRolestring(ContactRole)required

Contact Role

Enum"ACCOUNTS""TECHNICAL""SALES""GENERAL"
siteContacts[].​receiveInvoiceBystring(ReceiveInvoiceBy)

Receive invoice by email, post or both? Required when contactNameToAppearOnInvoice is set to true

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveInvoiceSummaryBystring(ReceiveInvoiceSummaryBy)

Receive invoice summary by email, post or both?

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveElectronicSummaryReportsboolean

Will receive electronic summary reports

siteContacts[].​emailSuspendedboolean

Whether the contact is unable to receive emails

Default false
siteContacts[].​contactNameToAppearOnInvoiceboolean

Only 1 contact per site can be set to true. If unspecified, this will be defaulted to the 1st contact. If specified for a different contact, it will be set to false for the previous one

Default false
siteContacts[].​receiveEmailFraudAlertboolean

Will receive a fraud alert by email

Default false
siteContacts[].​receiveSmsFraudAlertboolean

Will receive a fraud alert by SMS

Default false
repaymentPlanAmountnumber(decimal)[ 1 .. 100000 ]

Repayment plan period amount in major currency (e.g pounds/dollars/euros)

repaymentPlanRemainingPeriodsinteger(int64)[ 0 .. 240 ]

repayment plan remaining periods (typically in months)

Example: 0
assignedCustomFieldsArray of objects(AssignedCustomField)
Example: [{"customFieldDefinitionId":102,"label":"Customer Tier","value":"Gold"}]
curl -i -X POST \
  https://rest.elevatebilling.com/v1/sites \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": 0,
    "siteName": "string",
    "siteReference": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "siteAddress": {
      "businessName": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "country": "GB"
    },
    "siteInvoiceDetails": {
      "invoiceSummaryTemplateId": 0,
      "invoiceTemplateId": 0,
      "electronicSummaryTemplateIds": [
        123
      ],
      "invoiceSummaryTemplateComponents": [
        {}
      ],
      "invoiceAddress": {
        "businessName": "string",
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "country": "GB"
      },
      "accountPackageReference": "string",
      "paymentTermsInDays": 400,
      "preferredPaymentDay": 1,
      "paymentMethod": "CHEQUE",
      "mandateReference": "string",
      "thirdPartyCustomerReference": "string",
      "directDebitReference": "string",
      "accountName": "string",
      "accountNumber": "stringst",
      "sortCode": "string",
      "purchaseOrderNumber": "string",
      "invoiceNotes": "string",
      "taxExempt": false,
      "taxRegistrationNumber": "string"
    },
    "siteIdReceivingInvoice": 1,
    "siteContacts": [
      {
        "contactName": "string",
        "contactTelephoneNumber": "string",
        "contactAlternativeTelephoneNumber": "string",
        "contactEmailAddress": "string",
        "contactRole": "ACCOUNTS",
        "receiveInvoiceBy": "EMAIL",
        "receiveInvoiceSummaryBy": "EMAIL",
        "receiveElectronicSummaryReports": true,
        "emailSuspended": false,
        "contactNameToAppearOnInvoice": false,
        "receiveEmailFraudAlert": false,
        "receiveSmsFraudAlert": false
      }
    ],
    "repaymentPlanAmount": 1,
    "repaymentPlanRemainingPeriods": 0,
    "assignedCustomFields": [
      {
        "customFieldDefinitionId": 102,
        "label": "Customer Tier",
        "value": "Gold"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Site identifier

Example: 1
customerIdinteger(int64)required

Customer identifier - set to 0 when creating a new customer

Example: 0
siteNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site name

siteReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site reference

startDatestring(date)required

Site start date

endDatestring(date)

Site end date

createdDatestring(date-time)read-only

Site created date

updatedDatestring(date-time)read-only

Site updated date

siteAddressobject(Address)required
siteAddress.​idinteger(int64)read-only

Internal identifier for address entry

Example: 1
siteAddress.​businessNamestring[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Business name

siteAddress.​address1string[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Address line 1

siteAddress.​address2string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 2

siteAddress.​address3string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 3

siteAddress.​townstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Town

siteAddress.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

siteAddress.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

siteAddress.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
siteInvoiceDetailsobject(SiteInvoiceDetails)

Invoice details if this site should receive invoices

siteIdReceivingInvoiceinteger(int64)

Identifier of another site that receives the invoices if no invoice details provided for this site

Example: 1
siteContactsArray of objects(ContactDetails)non-emptyrequired
siteContacts[].​idinteger(int64)read-only

Contact identifier

Example: 1
siteContacts[].​contactNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Contact name

siteContacts[].​contactTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

siteContacts[].​contactAlternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact alternative telephone number

siteContacts[].​contactEmailAddressstring(EmailAddress)<= 255 characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...

Email address

siteContacts[].​contactRolestring(ContactRole)required

Contact Role

Enum"ACCOUNTS""TECHNICAL""SALES""GENERAL"
siteContacts[].​receiveInvoiceBystring(ReceiveInvoiceBy)

Receive invoice by email, post or both? Required when contactNameToAppearOnInvoice is set to true

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveInvoiceSummaryBystring(ReceiveInvoiceSummaryBy)

Receive invoice summary by email, post or both?

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveElectronicSummaryReportsboolean

Will receive electronic summary reports

siteContacts[].​emailSuspendedboolean

Whether the contact is unable to receive emails

Default false
siteContacts[].​contactNameToAppearOnInvoiceboolean

Only 1 contact per site can be set to true. If unspecified, this will be defaulted to the 1st contact. If specified for a different contact, it will be set to false for the previous one

Default false
siteContacts[].​receiveEmailFraudAlertboolean

Will receive a fraud alert by email

Default false
siteContacts[].​receiveSmsFraudAlertboolean

Will receive a fraud alert by SMS

Default false
repaymentPlanAmountnumber(decimal)[ 1 .. 100000 ]

Repayment plan period amount in major currency (e.g pounds/dollars/euros)

repaymentPlanRemainingPeriodsinteger(int64)[ 0 .. 240 ]

repayment plan remaining periods (typically in months)

Example: 0
assignedCustomFieldsArray of objects(AssignedCustomField)
Example: [{"customFieldDefinitionId":102,"label":"Customer Tier","value":"Gold"}]
Response
application/json
{
  "id": 1,
  "customerId": 0,
  "siteName": "string",
  "siteReference": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "siteAddress": {
    "id": 1,
    "businessName": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "GB"
  },
  "siteInvoiceDetails": {
    "invoiceSummaryTemplateId": 0,
    "invoiceTemplateId": 0,
    "electronicSummaryTemplateIds": [ … ],
    "invoiceSummaryTemplateComponents": [ … ],
    "invoiceAddress": { … },
    "accountPackageReference": "string",
    "paymentTermsInDays": 400,
    "preferredPaymentDay": 1,
    "paymentMethod": "CHEQUE",
    "mandateStatus": "string",
    "mandateCreatedDate": "2019-08-24T14:15:22Z",
    "mandateUpdatedDate": "2019-08-24T14:15:22Z",
    "mandateReference": "string",
    "thirdPartyCustomerReference": "string",
    "directDebitReference": "string",
    "accountName": "string",
    "accountNumber": "stringst",
    "sortCode": "string",
    "purchaseOrderNumber": "string",
    "invoiceNotes": "string",
    "taxExempt": false,
    "taxRegistrationNumber": "string"
  },
  "siteIdReceivingInvoice": 1,
  "siteContacts": [
    { … }
  ],
  "repaymentPlanAmount": 1,
  "repaymentPlanRemainingPeriods": 0,
  "assignedCustomFields": [
    { … }
  ]
}

Check if site exists

Request

Security
bearerAuth
Query
customerIdstring(IdFilterParam)

Filter by customer

Example: customerId=0
invoiceTemplateIdstring(IdFilterParam)

Filter by invoice template id

Example: invoiceTemplateId=0
billingCycleIdstring(IdFilterParam)

Filter by billing cycle id

Example: billingCycleId=0
siteNamestring(StringFilterParam)

Filter by site name

Example: siteName=xyz | in:x,y | like:xyz
siteReferencestring(StringFilterParam)

Filter by site reference

Example: siteReference=xyz | in:x,y | like:xyz
activeSitesstring(StringFilterParam)

Filter to exclude sites that are ended (end date is before today). The value is either true or false

Example: activeSites=xyz | in:x,y | like:xyz
contractOwnerSubBrandIdstring(IdFilterParam)

Filter by contract owner sub brand identifier

Example: contractOwnerSubBrandId=0
adhocBillRunIdstring(IdFilterParam)

Filter by adhoc bill run identifier

Example: adhocBillRunId=0
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/sites?customerId=0&invoiceTemplateId=0&billingCycleId=0&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&activeSites=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&contractOwnerSubBrandId=0&adhocBillRunId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of sites

Body

Get a specific site

Request

Security
bearerAuth
Path
site_idinteger(int64)(IdParam)>= 1required

Site identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/sites/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site found

Bodyapplication/json
idinteger(int64)read-only

Site identifier

Example: 1
customerIdinteger(int64)required

Customer identifier - set to 0 when creating a new customer

Example: 0
siteNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site name

siteReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site reference

startDatestring(date)required

Site start date

endDatestring(date)

Site end date

createdDatestring(date-time)read-only

Site created date

updatedDatestring(date-time)read-only

Site updated date

siteAddressobject(Address)required
siteAddress.​idinteger(int64)read-only

Internal identifier for address entry

Example: 1
siteAddress.​businessNamestring[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Business name

siteAddress.​address1string[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Address line 1

siteAddress.​address2string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 2

siteAddress.​address3string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 3

siteAddress.​townstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Town

siteAddress.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

siteAddress.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

siteAddress.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
siteInvoiceDetailsobject(SiteInvoiceDetails)

Invoice details if this site should receive invoices

siteIdReceivingInvoiceinteger(int64)

Identifier of another site that receives the invoices if no invoice details provided for this site

Example: 1
siteContactsArray of objects(ContactDetails)non-emptyrequired
siteContacts[].​idinteger(int64)read-only

Contact identifier

Example: 1
siteContacts[].​contactNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Contact name

siteContacts[].​contactTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

siteContacts[].​contactAlternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact alternative telephone number

siteContacts[].​contactEmailAddressstring(EmailAddress)<= 255 characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...

Email address

siteContacts[].​contactRolestring(ContactRole)required

Contact Role

Enum"ACCOUNTS""TECHNICAL""SALES""GENERAL"
siteContacts[].​receiveInvoiceBystring(ReceiveInvoiceBy)

Receive invoice by email, post or both? Required when contactNameToAppearOnInvoice is set to true

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveInvoiceSummaryBystring(ReceiveInvoiceSummaryBy)

Receive invoice summary by email, post or both?

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveElectronicSummaryReportsboolean

Will receive electronic summary reports

siteContacts[].​emailSuspendedboolean

Whether the contact is unable to receive emails

Default false
siteContacts[].​contactNameToAppearOnInvoiceboolean

Only 1 contact per site can be set to true. If unspecified, this will be defaulted to the 1st contact. If specified for a different contact, it will be set to false for the previous one

Default false
siteContacts[].​receiveEmailFraudAlertboolean

Will receive a fraud alert by email

Default false
siteContacts[].​receiveSmsFraudAlertboolean

Will receive a fraud alert by SMS

Default false
repaymentPlanAmountnumber(decimal)[ 1 .. 100000 ]

Repayment plan period amount in major currency (e.g pounds/dollars/euros)

repaymentPlanRemainingPeriodsinteger(int64)[ 0 .. 240 ]

repayment plan remaining periods (typically in months)

Example: 0
assignedCustomFieldsArray of objects(AssignedCustomField)
Example: [{"customFieldDefinitionId":102,"label":"Customer Tier","value":"Gold"}]
Response
application/json
{
  "id": 1,
  "customerId": 0,
  "siteName": "string",
  "siteReference": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "siteAddress": {
    "id": 1,
    "businessName": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "GB"
  },
  "siteInvoiceDetails": {
    "invoiceSummaryTemplateId": 0,
    "invoiceTemplateId": 0,
    "electronicSummaryTemplateIds": [ … ],
    "invoiceSummaryTemplateComponents": [ … ],
    "invoiceAddress": { … },
    "accountPackageReference": "string",
    "paymentTermsInDays": 400,
    "preferredPaymentDay": 1,
    "paymentMethod": "CHEQUE",
    "mandateStatus": "string",
    "mandateCreatedDate": "2019-08-24T14:15:22Z",
    "mandateUpdatedDate": "2019-08-24T14:15:22Z",
    "mandateReference": "string",
    "thirdPartyCustomerReference": "string",
    "directDebitReference": "string",
    "accountName": "string",
    "accountNumber": "stringst",
    "sortCode": "string",
    "purchaseOrderNumber": "string",
    "invoiceNotes": "string",
    "taxExempt": false,
    "taxRegistrationNumber": "string"
  },
  "siteIdReceivingInvoice": 1,
  "siteContacts": [
    { … }
  ],
  "repaymentPlanAmount": 1,
  "repaymentPlanRemainingPeriods": 0,
  "assignedCustomFields": [
    { … }
  ]
}

Update a site

Request

Security
bearerAuth
Path
site_idinteger(int64)(IdParam)>= 1required

Site identifier

Example: 1
Headers
cascade_end_datestring(BooleanFilterParam)

A boolean flag to specify that the end date is to be cascaded down to all inventories. An end date must be supplied in the patch for this flag to apply

Example: true | false
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/sites/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'cascade_end_date: true | false' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "Head Office"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Site identifier

Example: 1
customerIdinteger(int64)required

Customer identifier - set to 0 when creating a new customer

Example: 0
siteNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site name

siteReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Site reference

startDatestring(date)required

Site start date

endDatestring(date)

Site end date

createdDatestring(date-time)read-only

Site created date

updatedDatestring(date-time)read-only

Site updated date

siteAddressobject(Address)required
siteAddress.​idinteger(int64)read-only

Internal identifier for address entry

Example: 1
siteAddress.​businessNamestring[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Business name

siteAddress.​address1string[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Address line 1

siteAddress.​address2string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 2

siteAddress.​address3string[ 0 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Address line 3

siteAddress.​townstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Town

siteAddress.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

siteAddress.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

siteAddress.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
siteInvoiceDetailsobject(SiteInvoiceDetails)

Invoice details if this site should receive invoices

siteIdReceivingInvoiceinteger(int64)

Identifier of another site that receives the invoices if no invoice details provided for this site

Example: 1
siteContactsArray of objects(ContactDetails)non-emptyrequired
siteContacts[].​idinteger(int64)read-only

Contact identifier

Example: 1
siteContacts[].​contactNamestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Contact name

siteContacts[].​contactTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

siteContacts[].​contactAlternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact alternative telephone number

siteContacts[].​contactEmailAddressstring(EmailAddress)<= 255 characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...

Email address

siteContacts[].​contactRolestring(ContactRole)required

Contact Role

Enum"ACCOUNTS""TECHNICAL""SALES""GENERAL"
siteContacts[].​receiveInvoiceBystring(ReceiveInvoiceBy)

Receive invoice by email, post or both? Required when contactNameToAppearOnInvoice is set to true

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveInvoiceSummaryBystring(ReceiveInvoiceSummaryBy)

Receive invoice summary by email, post or both?

Enum"EMAIL""POST""EMAIL_AND_POST"
siteContacts[].​receiveElectronicSummaryReportsboolean

Will receive electronic summary reports

siteContacts[].​emailSuspendedboolean

Whether the contact is unable to receive emails

Default false
siteContacts[].​contactNameToAppearOnInvoiceboolean

Only 1 contact per site can be set to true. If unspecified, this will be defaulted to the 1st contact. If specified for a different contact, it will be set to false for the previous one

Default false
siteContacts[].​receiveEmailFraudAlertboolean

Will receive a fraud alert by email

Default false
siteContacts[].​receiveSmsFraudAlertboolean

Will receive a fraud alert by SMS

Default false
repaymentPlanAmountnumber(decimal)[ 1 .. 100000 ]

Repayment plan period amount in major currency (e.g pounds/dollars/euros)

repaymentPlanRemainingPeriodsinteger(int64)[ 0 .. 240 ]

repayment plan remaining periods (typically in months)

Example: 0
assignedCustomFieldsArray of objects(AssignedCustomField)
Example: [{"customFieldDefinitionId":102,"label":"Customer Tier","value":"Gold"}]
Response
application/json
{
  "id": 1,
  "customerId": 0,
  "siteName": "string",
  "siteReference": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "siteAddress": {
    "id": 1,
    "businessName": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "GB"
  },
  "siteInvoiceDetails": {
    "invoiceSummaryTemplateId": 0,
    "invoiceTemplateId": 0,
    "electronicSummaryTemplateIds": [ … ],
    "invoiceSummaryTemplateComponents": [ … ],
    "invoiceAddress": { … },
    "accountPackageReference": "string",
    "paymentTermsInDays": 400,
    "preferredPaymentDay": 1,
    "paymentMethod": "CHEQUE",
    "mandateStatus": "string",
    "mandateCreatedDate": "2019-08-24T14:15:22Z",
    "mandateUpdatedDate": "2019-08-24T14:15:22Z",
    "mandateReference": "string",
    "thirdPartyCustomerReference": "string",
    "directDebitReference": "string",
    "accountName": "string",
    "accountNumber": "stringst",
    "sortCode": "string",
    "purchaseOrderNumber": "string",
    "invoiceNotes": "string",
    "taxExempt": false,
    "taxRegistrationNumber": "string"
  },
  "siteIdReceivingInvoice": 1,
  "siteContacts": [
    { … }
  ],
  "repaymentPlanAmount": 1,
  "repaymentPlanRemainingPeriods": 0,
  "assignedCustomFields": [
    { … }
  ]
}