Get a list of available sites

get/sites
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

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

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

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

Example: fields=id,name
customerId
string (IdFilterParam)

Filter by customer

Example: customerId=0
siteName
string (StringFilterParam)

Filter by site name

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

Filter by site reference

Example: siteReference=xyz | in:x,y | like:xyz
createdDate
string (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
updatedDate
string (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
mandateStatus
string (StringFilterParam)

Filter by mandate status

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

Filter by mandate created date

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

Filter by mandate updated date

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

Filter by mandate reference

Example: mandateReference=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Response samples
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,
      • "invoiceAddress": {
        • "id": 1,
        • "businessName": "string",
        • "address1": "string",
        • "address2": "string",
        • "address3": "string",
        • "town": "string",
        • "county": "string",
        • "postcode": "string",
        • "country": "GB"
        },
      • "accountPackageReference": "string",
      • "paymentTermsInDays": 400,
      • "preferredPaymentDay": 1,
      • "paymentMethod": "CHEQUE",
      • "mandateStatus": "string",
      • "mandateCreatedDate": "2019-08-24T14:15:22Z",
      • "mandateUpdatedDate": "2019-08-24T14:15:22Z",
      • "mandateReference": "string",
      • "directDebitReference": "string",
      • "accountName": "string",
      • "accountNumber": "stringst",
      • "sortCode": "string",
      • "purchaseOrderNumber": "string",
      • "invoiceNotes": "string",
      • "taxExempt": false,
      • "taxRegistrationNumber": "string"
      },
    • "siteIdReceivingInvoice": 1,
    • "siteContacts": [
      • {
        • "id": 1,
        • "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
    }
]