Get a list of available customers

get/customers
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
contractOwnerId
string (IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
customerName
string (StringFilterParam)

Filter by customer name

Example: customerName=xyz | in:x,y | like:xyz
customerType
string (StringFilterParam)

Filter by customer type

Example: customerType=xyz | in:x,y | like:xyz
customerAccountNumber
string (StringFilterParam)

Filter by customer account number

Example: customerAccountNumber=xyz | in:x,y | like:xyz
billingCycleId
string (IdFilterParam)

Filter by billing cycle

Example: billingCycleId=0
startDate
string (DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDate
string (DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "contractOwnerId": 0,
    • "contractOwnerSubBrandId": 0,
    • "customerType": "RESIDENTIAL",
    • "customerName": "string",
    • "customerAccountNumber": "string",
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "contractTerm": 0,
    • "contractTermStartDate": "2019-08-24",
    • "customerIsVip": false,
    • "customerMarker": false,
    • "externalCommissionAgentId": 1,
    • "onlineBillingRequired": false,
    • "onlineEmailAddress": "string",
    • "sendWelcomeEmailOn": "2019-08-24",
    • "billingCycleId": 1,
    • "sites": [
      • {
        • "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
        }
      ],
    • "creditThreshold": 100,
    • "tripwireId": 0,
    • "customerContacts": [
      • {
        • "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
        }
      ]
    }
]