Get a specific site

get/sites/{site_id}
SecuritybearerAuth
Request
path Parameters
site_id
required
integer <int64> (IdParam) >= 1

Site identifier

Example: 1
Responses
200

Site found

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,
    • "electronicSummaryTemplateIds": [
      • 123
      ],
    • "invoiceSummaryTemplateComponents": [
      • {
        • "id": 1,
        • "positionInTemplate": 1
        }
      ],
    • "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",
    • "thirdPartyCustomerReference": "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,
  • "assignedCustomFields": [
    • {
      • "customFieldDefinitionId": 102,
      • "label": "Customer Tier",
      • "value": "Gold"
      }
    ]
}